Apache Pulsar Ticket Registry
The Apache Pulsar ticket registry is very much an extension of the default ticket registry. The difference is that ticket operations applied to the registry are broadcasted using Pulsar topics to other listening CAS nodes. 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.
The broadcast and pub/sub mechanism is backed by Apache Pulsar. Apache Pulsar is an open-source, distributed messaging and streaming platform built for the cloud.
In Apache Pulsar, topics do not need to be created beforehand. They are created automatically on first use, as long as:
- The namespace exists, and
- Auto-creation is enabled in the broker configuration (it is enabled by default in most local/docker setups).
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-pulsar-ticket-registry</artifactId>
<version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-support-pulsar-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-pulsar-ticket-registry"
}
1
2
3
4
5
6
7
8
9
10
dependencies {
/*
The following platform references are included automatically and are listed 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-pulsar-ticket-registry"
}
CAS Configuration
The following settings and properties are available from the CAS configuration catalog:
cas.ticket.registry.in-memory.crypto.encryption.keyThe 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.in-memory.crypto.signing.keyThe signing key is a string whose length is defined by the signing key size setting.
The signing key is a string whose length is defined by the signing key size setting.
cas.ticket.registry.in-memory.concurrencyThe estimated number of concurrently updating threads.
20The estimated number of concurrently updating threads. The implementation performs internal sizing to try to accommodate this many threads.
cas.ticket.registry.in-memory.crypto.algThe signing/encryption algorithm to use.
AESThe signing/encryption algorithm to use.
cas.ticket.registry.in-memory.crypto.enabledWhether crypto operations are enabled.
trueWhether crypto operations are enabled.
cas.ticket.registry.in-memory.crypto.encryption.key-sizeEncryption key size.
16Encryption key size.
cas.ticket.registry.in-memory.crypto.signing-enabledWhether signing encryption operations are enabled.
trueWhether signing encryption operations are enabled.
cas.ticket.registry.in-memory.crypto.signing.key-sizeThe signing key size.
512The signing key size.
cas.ticket.registry.in-memory.initial-capacityThe initial capacity of the underlying memory store.
1000The initial capacity of the underlying memory store. The implementation performs internal sizing to accommodate this many elements.
cas.ticket.registry.in-memory.load-factorThe load factor threshold, used to control resizing.
1The load factor threshold, used to control resizing. Resizing may be performed when the average number of elements per bin exceeds this threshold.
cas.ticket.registry.in-memory.propertiesFree-form key-value pairs to configure the specific registry with custom settings.
Free-form key-value pairs to configure the specific registry with custom settings.
cas.ticket.registry.pulsar.concurrency
1cas.ticket.registry.pulsar.subscription-name
cas-pulsar-ticket-registry-subscriptionspring.pulsar.admin.authentication.paramAuthentication parameter(s) as a map of parameter names to parameter values.
Authentication parameter(s) as a map of parameter names to parameter values.
spring.pulsar.admin.authentication.plugin-class-nameFully qualified class name of the authentication plugin.
Fully qualified class name of the authentication plugin.
spring.pulsar.admin.connection-timeoutDuration to wait for a connection to server to be established.
1mDuration to wait for a connection to server to be established.
spring.pulsar.admin.read-timeoutServer response read time out for any request.
1mServer response read time out for any request.
spring.pulsar.admin.request-timeoutServer request time out for any request.
5mServer request time out for any request.
spring.pulsar.admin.service-urlPulsar web URL for the admin endpoint in the format '(http|https)://host:port'.
http://localhost:8080Pulsar web URL for the admin endpoint in the format '(http|https)://host:port'.
spring.pulsar.client.authentication.paramAuthentication parameter(s) as a map of parameter names to parameter values.
Authentication parameter(s) as a map of parameter names to parameter values.
spring.pulsar.client.authentication.plugin-class-nameFully qualified class name of the authentication plugin.
Fully qualified class name of the authentication plugin.
spring.pulsar.client.connection-timeoutDuration to wait for a connection to a broker to be established.
10sDuration to wait for a connection to a broker to be established.
spring.pulsar.client.failover.backup-clustersList of backup clusters.
List of backup clusters. The backup cluster is chosen in the sequence of the given list. If all backup clusters are available, the Pulsar client chooses the first backup cluster.
spring.pulsar.client.failover.check-intervalFrequency of performing a probe task.
Frequency of performing a probe task.
spring.pulsar.client.failover.delayDelay before the Pulsar client switches from the primary cluster to the backup cluster.
Delay before the Pulsar client switches from the primary cluster to the backup cluster.
spring.pulsar.client.failover.policyCluster failover policy.
orderCluster failover policy.
spring.pulsar.client.failover.switch-back-delayDelay before the Pulsar client switches from the backup cluster to the primary cluster.
Delay before the Pulsar client switches from the backup cluster to the primary cluster.
spring.pulsar.client.lookup-timeoutClient lookup timeout.
Client lookup timeout.
spring.pulsar.client.operation-timeoutClient operation timeout.
30sClient operation timeout.
spring.pulsar.client.service-urlPulsar service URL in the format '(pulsar|pulsar+ssl)://host:port'.
pulsar://localhost:6650Pulsar service URL in the format '(pulsar|pulsar+ssl)://host:port'.
spring.pulsar.client.threads.ioNumber of threads to be used for handling connections to brokers.
Number of threads to be used for handling connections to brokers.
spring.pulsar.client.threads.listenerNumber of threads to be used for message listeners.
Number of threads to be used for message listeners.
spring.pulsar.consumer.dead-letter-policy.dead-letter-topicName of the dead topic where the failing messages will be sent.
Name of the dead topic where the failing messages will be sent.
spring.pulsar.consumer.dead-letter-policy.initial-subscription-nameName of the initial subscription of the dead letter topic.
Name of the initial subscription of the dead letter topic. When not set, the initial subscription will not be created. However, when the property is set then the broker's 'allowAutoSubscriptionCreation' must be enabled or the DLQ producer will fail.
spring.pulsar.consumer.dead-letter-policy.max-redeliver-countMaximum number of times that a message will be redelivered before being sent to the dead letter queue.
0Maximum number of times that a message will be redelivered before being sent to the dead letter queue.
spring.pulsar.consumer.dead-letter-policy.retry-letter-topicName of the retry topic where the failing messages will be sent.
Name of the retry topic where the failing messages will be sent.
spring.pulsar.consumer.nameConsumer name to identify a particular consumer from the topic stats.
Consumer name to identify a particular consumer from the topic stats.
spring.pulsar.consumer.priority-levelPriority level for shared subscription consumers.
0Priority level for shared subscription consumers.
spring.pulsar.consumer.read-compactedWhether to read messages from the compacted topic rather than the full message backlog.
falseWhether to read messages from the compacted topic rather than the full message backlog.
spring.pulsar.consumer.retry-enableWhether to auto retry messages.
falseWhether to auto retry messages.
spring.pulsar.consumer.subscription.initial-positionPosition where to initialize a newly created subscription.
latestPosition where to initialize a newly created subscription.
spring.pulsar.consumer.subscription.modeSubscription mode to be used when subscribing to the topic.
durableSubscription mode to be used when subscribing to the topic.
spring.pulsar.consumer.subscription.nameSubscription name for the consumer.
Subscription name for the consumer.
spring.pulsar.consumer.subscription.topics-modeDetermines which type of topics (persistent, non-persistent, or all) the consumer should be subscribed to when using pattern subscriptions.
persistentonlyDetermines which type of topics (persistent, non-persistent, or all) the consumer should be subscribed to when using pattern subscriptions.
spring.pulsar.consumer.subscription.typeSubscription type to be used when subscribing to a topic.
exclusiveSubscription type to be used when subscribing to a topic.
spring.pulsar.consumer.topicsTopics the consumer subscribes to.
Topics the consumer subscribes to.
spring.pulsar.consumer.topics-patternPattern for topics the consumer subscribes to.
Pattern for topics the consumer subscribes to.
spring.pulsar.defaults.topic.enabledWhether to enable default tenant and namespace support for topics.
trueWhether to enable default tenant and namespace support for topics.
spring.pulsar.defaults.topic.namespaceDefault namespace to use when producing or consuming messages against a non-fully-qualified topic URL.
defaultDefault namespace to use when producing or consuming messages against a non-fully-qualified topic URL.
spring.pulsar.defaults.topic.tenantDefault tenant to use when producing or consuming messages against a non-fully-qualified topic URL.
publicDefault tenant to use when producing or consuming messages against a non-fully-qualified topic URL.
spring.pulsar.defaults.type-mappingsList of mappings from message type to topic name and schema info to use as a defaults when a topic name and/or schema is not explicitly specified when producing or consuming messages of the mapped type.
List of mappings from message type to topic name and schema info to use as a defaults when a topic name and/or schema is not explicitly specified when producing or consuming messages of the mapped type.
spring.pulsar.function.enabledWhether to enable function support.
trueWhether to enable function support.
spring.pulsar.function.fail-fastWhether to stop processing further function creates/updates when a failure occurs.
trueWhether to stop processing further function creates/updates when a failure occurs.
spring.pulsar.function.propagate-failuresWhether to throw an exception if any failure is encountered during server startup while creating/updating functions.
trueWhether to throw an exception if any failure is encountered during server startup while creating/updating functions.
spring.pulsar.function.propagate-stop-failuresWhether to throw an exception if any failure is encountered during server shutdown while enforcing stop policy on functions.
falseWhether to throw an exception if any failure is encountered during server shutdown while enforcing stop policy on functions.
spring.pulsar.listener.concurrencyNumber of threads used by listener container.
Number of threads used by listener container.
spring.pulsar.listener.observation-enabledWhether to record observations for when the Observations API is available and the client supports it.
falseWhether to record observations for when the Observations API is available and the client supports it.
spring.pulsar.listener.schema-typeSchemaType of the consumed messages.
SchemaType of the consumed messages.
spring.pulsar.producer.access-modeType of access to the topic the producer requires.
sharedType of access to the topic the producer requires.
spring.pulsar.producer.batching-enabledWhether to automatically batch messages.
trueWhether to automatically batch messages.
spring.pulsar.producer.cache.enabledWhether to enable caching in the PulsarProducerFactory.
trueWhether to enable caching in the PulsarProducerFactory.
spring.pulsar.producer.cache.expire-after-accessTime period to expire unused entries in the cache.
1mTime period to expire unused entries in the cache.
spring.pulsar.producer.cache.initial-capacityInitial size of cache.
50Initial size of cache.
spring.pulsar.producer.cache.maximum-sizeMaximum size of cache (entries).
1000Maximum size of cache (entries).
spring.pulsar.producer.chunking-enabledWhether to split large-size messages into multiple chunks.
falseWhether to split large-size messages into multiple chunks.
spring.pulsar.producer.compression-typeMessage compression type.
Message compression type.
spring.pulsar.producer.hashing-schemeMessage hashing scheme to choose the partition to which the message is published.
javastringhashMessage hashing scheme to choose the partition to which the message is published.
spring.pulsar.producer.message-routing-modeMessage routing mode for a partitioned producer.
roundrobinpartitionMessage routing mode for a partitioned producer.
spring.pulsar.producer.nameName for the producer.
Name for the producer. If not assigned, a unique name is generated.
spring.pulsar.producer.send-timeoutTime before a message has to be acknowledged by the broker.
30sTime before a message has to be acknowledged by the broker.
spring.pulsar.producer.topic-nameTopic the producer will publish to.
Topic the producer will publish to.
spring.pulsar.reader.nameReader name.
Reader name.
spring.pulsar.reader.read-compactedWhether to read messages from a compacted topic rather than a full message backlog of a topic.
falseWhether to read messages from a compacted topic rather than a full message backlog of a topic.
spring.pulsar.reader.subscription-nameSubscription name.
Subscription name.
spring.pulsar.reader.subscription-role-prefixPrefix of subscription role.
Prefix of subscription role.
spring.pulsar.reader.topicsTopics the reader subscribes to.
Topics the reader subscribes to.
spring.pulsar.template.observations-enabledWhether to record observations for when the Observations API is available.
falseWhether to record observations for when the Observations API is available.
spring.pulsar.transaction.enabledWhether transaction support is enabled.
falseWhether transaction support is enabled.
Required settings may be needed to activate or affect the feature; review them even when they have a default. Optional settings only need to be set to change a default or to turn on the behavior they control. Third party settings belong to libraries such as Spring Boot that CAS builds on; their own documentation may have more detail.
Signing & encryption
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.
Groovy scripting
CAS takes advantage of Apache Groovy in forms of either embedded or external scripts that allow one to, by default, dynamically build constructs, attributes, access strategies and a lot more. To activate the functionality described here, you may need to prepare CAS to support and integrate with Apache Groovy.
Please review this guide to configure your build.
Notes on configuration
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, especially if defined CAS settings cannot be recognized or validated by the configuration schema. 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
7
8
9
10
...
<Logger name="org.springframework.pulsar" level="debug" additivity="false">
<AppenderRef ref="casConsole"/>
<AppenderRef ref="casFile"/>
</Logger>
<Logger name="org.apache.pulsar" level="debug" additivity="false">
<AppenderRef ref="casConsole"/>
<AppenderRef ref="casFile"/>
</Logger>
...