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.
no default
Required

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.

Type
String
Default
none
Defined by
EncryptionRandomizedCryptoProperties
cas.ticket.registry.in-memory.crypto.signing.keyThe signing key is a string whose length is defined by the signing key size setting.
no default
RequiredSpEL

The signing key is a string whose length is defined by the signing key size setting.

Type
String
Default
none
Defined by
SigningJwtCryptoProperties
Supports
Spring Expression Language
cas.ticket.registry.in-memory.concurrencyThe estimated number of concurrently updating threads.
20

The estimated number of concurrently updating threads. The implementation performs internal sizing to try to accommodate this many threads.

Type
Integer
Default
20
Defined by
InMemoryTicketRegistryProperties
cas.ticket.registry.in-memory.crypto.algThe signing/encryption algorithm to use.
AES

The signing/encryption algorithm to use.

Type
String
Default
AES
Defined by
EncryptionRandomizedSigningJwtCryptographyProperties
cas.ticket.registry.in-memory.crypto.enabledWhether crypto operations are enabled.
true

Whether crypto operations are enabled.

Type
Boolean
Default
true
Defined by
EncryptionRandomizedSigningJwtCryptographyProperties
cas.ticket.registry.in-memory.crypto.encryption.key-sizeEncryption key size.
16

Encryption key size.

Type
Integer
Default
16
Defined by
EncryptionRandomizedCryptoProperties
cas.ticket.registry.in-memory.crypto.signing-enabledWhether signing encryption operations are enabled.
true

Whether signing encryption operations are enabled.

Type
Boolean
Default
true
Defined by
EncryptionRandomizedSigningJwtCryptographyProperties
cas.ticket.registry.in-memory.crypto.signing.key-sizeThe signing key size.
512

The signing key size.

Type
Integer
Default
512
Defined by
SigningJwtCryptoProperties
cas.ticket.registry.in-memory.initial-capacityThe initial capacity of the underlying memory store.
1000

The initial capacity of the underlying memory store. The implementation performs internal sizing to accommodate this many elements.

Type
Integer
Default
1000
Defined by
InMemoryTicketRegistryProperties
cas.ticket.registry.in-memory.load-factorThe load factor threshold, used to control resizing.
1

The load factor threshold, used to control resizing. Resizing may be performed when the average number of elements per bin exceeds this threshold.

Type
Integer
Default
1
Defined by
InMemoryTicketRegistryProperties
cas.ticket.registry.in-memory.propertiesFree-form key-value pairs to configure the specific registry with custom settings.
no default

Free-form key-value pairs to configure the specific registry with custom settings.

Type
Map<String,String>
Default
none
Defined by
InMemoryTicketRegistryProperties
cas.ticket.registry.pulsar.concurrency
1
Type
Integer
Default
1
Defined by
PulsarTicketRegistryProperties
cas.ticket.registry.pulsar.subscription-name
cas-pulsar-ticket-registry-subscription
Type
String
Default
cas-pulsar-ticket-registry-subscription
Defined by
PulsarTicketRegistryProperties
spring.pulsar.admin.authentication.paramAuthentication parameter(s) as a map of parameter names to parameter values.
no default
Third party

Authentication parameter(s) as a map of parameter names to parameter values.

Type
Map<String,String>
Default
none
Defined by
PulsarProperties$Authentication
spring.pulsar.admin.authentication.plugin-class-nameFully qualified class name of the authentication plugin.
no default
Third party

Fully qualified class name of the authentication plugin.

Type
String
Default
none
Defined by
PulsarProperties$Authentication
spring.pulsar.admin.connection-timeoutDuration to wait for a connection to server to be established.
1m
Third party

Duration to wait for a connection to server to be established.

Type
Duration
Default
1m
Defined by
PulsarProperties$Admin
spring.pulsar.admin.read-timeoutServer response read time out for any request.
1m
Third party

Server response read time out for any request.

Type
Duration
Default
1m
Defined by
PulsarProperties$Admin
spring.pulsar.admin.request-timeoutServer request time out for any request.
5m
Third party

Server request time out for any request.

Type
Duration
Default
5m
Defined by
PulsarProperties$Admin
spring.pulsar.admin.service-urlPulsar web URL for the admin endpoint in the format '(http|https)://host:port'.
http://localhost:8080
Third party

Pulsar web URL for the admin endpoint in the format '(http|https)://host:port'.

Type
String
Default
http://localhost:8080
Defined by
PulsarProperties$Admin
spring.pulsar.client.authentication.paramAuthentication parameter(s) as a map of parameter names to parameter values.
no default
Third party

Authentication parameter(s) as a map of parameter names to parameter values.

Type
Map<String,String>
Default
none
Defined by
PulsarProperties$Authentication
spring.pulsar.client.authentication.plugin-class-nameFully qualified class name of the authentication plugin.
no default
Third party

Fully qualified class name of the authentication plugin.

Type
String
Default
none
Defined by
PulsarProperties$Authentication
spring.pulsar.client.connection-timeoutDuration to wait for a connection to a broker to be established.
10s
Third party

Duration to wait for a connection to a broker to be established.

Type
Duration
Default
10s
Defined by
PulsarProperties$Client
spring.pulsar.client.failover.backup-clustersList of backup clusters.
no default
Third party

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.

Type
List<PulsarProperties.Failover.BackupCluster>
Default
none
Defined by
PulsarProperties$Failover
spring.pulsar.client.failover.check-intervalFrequency of performing a probe task.
no default
Third party

Frequency of performing a probe task.

Type
Duration
Default
none
Defined by
PulsarProperties$Failover
spring.pulsar.client.failover.delayDelay before the Pulsar client switches from the primary cluster to the backup cluster.
no default
Third party

Delay before the Pulsar client switches from the primary cluster to the backup cluster.

Type
Duration
Default
none
Defined by
PulsarProperties$Failover
spring.pulsar.client.failover.policyCluster failover policy.
order
Third party

Cluster failover policy.

Type
AutoClusterFailoverBuilder.FailoverPolicy
Default
order
Defined by
PulsarProperties$Failover
spring.pulsar.client.failover.switch-back-delayDelay before the Pulsar client switches from the backup cluster to the primary cluster.
no default
Third party

Delay before the Pulsar client switches from the backup cluster to the primary cluster.

Type
Duration
Default
none
Defined by
PulsarProperties$Failover
spring.pulsar.client.lookup-timeoutClient lookup timeout.
no default
Third party

Client lookup timeout.

Type
Duration
Default
none
Defined by
PulsarProperties$Client
spring.pulsar.client.operation-timeoutClient operation timeout.
30s
Third party

Client operation timeout.

Type
Duration
Default
30s
Defined by
PulsarProperties$Client
spring.pulsar.client.service-urlPulsar service URL in the format '(pulsar|pulsar+ssl)://host:port'.
pulsar://localhost:6650
Third party

Pulsar service URL in the format '(pulsar|pulsar+ssl)://host:port'.

Type
String
Default
pulsar://localhost:6650
Defined by
PulsarProperties$Client
spring.pulsar.client.threads.ioNumber of threads to be used for handling connections to brokers.
no default
Third party

Number of threads to be used for handling connections to brokers.

Type
Integer
Default
none
Defined by
PulsarProperties$Threads
spring.pulsar.client.threads.listenerNumber of threads to be used for message listeners.
no default
Third party

Number of threads to be used for message listeners.

Type
Integer
Default
none
Defined by
PulsarProperties$Threads
spring.pulsar.consumer.dead-letter-policy.dead-letter-topicName of the dead topic where the failing messages will be sent.
no default
Third party

Name of the dead topic where the failing messages will be sent.

Type
String
Default
none
Defined by
PulsarProperties$Consumer$DeadLetterPolicy
spring.pulsar.consumer.dead-letter-policy.initial-subscription-nameName of the initial subscription of the dead letter topic.
no default
Third party

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.

Type
String
Default
none
Defined by
PulsarProperties$Consumer$DeadLetterPolicy
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.
0
Third party

Maximum number of times that a message will be redelivered before being sent to the dead letter queue.

Type
Integer
Default
0
Defined by
PulsarProperties$Consumer$DeadLetterPolicy
spring.pulsar.consumer.dead-letter-policy.retry-letter-topicName of the retry topic where the failing messages will be sent.
no default
Third party

Name of the retry topic where the failing messages will be sent.

Type
String
Default
none
Defined by
PulsarProperties$Consumer$DeadLetterPolicy
spring.pulsar.consumer.nameConsumer name to identify a particular consumer from the topic stats.
no default
Third party

Consumer name to identify a particular consumer from the topic stats.

Type
String
Default
none
Defined by
PulsarProperties$Consumer
spring.pulsar.consumer.priority-levelPriority level for shared subscription consumers.
0
Third party

Priority level for shared subscription consumers.

Type
Integer
Default
0
Defined by
PulsarProperties$Consumer
spring.pulsar.consumer.read-compactedWhether to read messages from the compacted topic rather than the full message backlog.
false
Third party

Whether to read messages from the compacted topic rather than the full message backlog.

Type
Boolean
Default
false
Defined by
PulsarProperties$Consumer
spring.pulsar.consumer.retry-enableWhether to auto retry messages.
false
Third party

Whether to auto retry messages.

Type
Boolean
Default
false
Defined by
PulsarProperties$Consumer
spring.pulsar.consumer.subscription.initial-positionPosition where to initialize a newly created subscription.
latest
Third party

Position where to initialize a newly created subscription.

Type
SubscriptionInitialPosition
Default
latest
Defined by
PulsarProperties$Consumer$Subscription
spring.pulsar.consumer.subscription.modeSubscription mode to be used when subscribing to the topic.
durable
Third party

Subscription mode to be used when subscribing to the topic.

Type
SubscriptionMode
Default
durable
Defined by
PulsarProperties$Consumer$Subscription
spring.pulsar.consumer.subscription.nameSubscription name for the consumer.
no default
Third party

Subscription name for the consumer.

Type
String
Default
none
Defined by
PulsarProperties$Consumer$Subscription
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.
persistentonly
Third party

Determines which type of topics (persistent, non-persistent, or all) the consumer should be subscribed to when using pattern subscriptions.

Type
RegexSubscriptionMode
Default
persistentonly
Defined by
PulsarProperties$Consumer$Subscription
spring.pulsar.consumer.subscription.typeSubscription type to be used when subscribing to a topic.
exclusive
Third party

Subscription type to be used when subscribing to a topic.

Type
SubscriptionType
Default
exclusive
Defined by
PulsarProperties$Consumer$Subscription
spring.pulsar.consumer.topicsTopics the consumer subscribes to.
no default
Third party

Topics the consumer subscribes to.

Type
List<String>
Default
none
Defined by
PulsarProperties$Consumer
spring.pulsar.consumer.topics-patternPattern for topics the consumer subscribes to.
no default
Third party

Pattern for topics the consumer subscribes to.

Type
Pattern
Default
none
Defined by
PulsarProperties$Consumer
spring.pulsar.defaults.topic.enabledWhether to enable default tenant and namespace support for topics.
true
Third party

Whether to enable default tenant and namespace support for topics.

Type
Boolean
Default
true
spring.pulsar.defaults.topic.namespaceDefault namespace to use when producing or consuming messages against a non-fully-qualified topic URL.
default
Third party

Default namespace to use when producing or consuming messages against a non-fully-qualified topic URL.

Type
String
Default
default
Defined by
PulsarProperties$Defaults$Topic
spring.pulsar.defaults.topic.tenantDefault tenant to use when producing or consuming messages against a non-fully-qualified topic URL.
public
Third party

Default tenant to use when producing or consuming messages against a non-fully-qualified topic URL.

Type
String
Default
public
Defined by
PulsarProperties$Defaults$Topic
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.
no default
Third party

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.

Type
List<PulsarProperties.Defaults.TypeMapping>
Default
none
Defined by
PulsarProperties$Defaults
spring.pulsar.function.enabledWhether to enable function support.
true
Third party

Whether to enable function support.

Type
Boolean
Default
true
spring.pulsar.function.fail-fastWhether to stop processing further function creates/updates when a failure occurs.
true
Third party

Whether to stop processing further function creates/updates when a failure occurs.

Type
Boolean
Default
true
Defined by
PulsarProperties$Function
spring.pulsar.function.propagate-failuresWhether to throw an exception if any failure is encountered during server startup while creating/updating functions.
true
Third party

Whether to throw an exception if any failure is encountered during server startup while creating/updating functions.

Type
Boolean
Default
true
Defined by
PulsarProperties$Function
spring.pulsar.function.propagate-stop-failuresWhether to throw an exception if any failure is encountered during server shutdown while enforcing stop policy on functions.
false
Third party

Whether to throw an exception if any failure is encountered during server shutdown while enforcing stop policy on functions.

Type
Boolean
Default
false
Defined by
PulsarProperties$Function
spring.pulsar.listener.concurrencyNumber of threads used by listener container.
no default
Third party

Number of threads used by listener container.

Type
Integer
Default
none
Defined by
PulsarProperties$Listener
spring.pulsar.listener.observation-enabledWhether to record observations for when the Observations API is available and the client supports it.
false
Third party

Whether to record observations for when the Observations API is available and the client supports it.

Type
Boolean
Default
false
Defined by
PulsarProperties$Listener
spring.pulsar.listener.schema-typeSchemaType of the consumed messages.
no default
Third party

SchemaType of the consumed messages.

Type
SchemaType
Default
none
Defined by
PulsarProperties$Listener
spring.pulsar.producer.access-modeType of access to the topic the producer requires.
shared
Third party

Type of access to the topic the producer requires.

Type
ProducerAccessMode
Default
shared
Defined by
PulsarProperties$Producer
spring.pulsar.producer.batching-enabledWhether to automatically batch messages.
true
Third party

Whether to automatically batch messages.

Type
Boolean
Default
true
Defined by
PulsarProperties$Producer
spring.pulsar.producer.cache.enabledWhether to enable caching in the PulsarProducerFactory.
true
Third party

Whether to enable caching in the PulsarProducerFactory.

Type
Boolean
Default
true
spring.pulsar.producer.cache.expire-after-accessTime period to expire unused entries in the cache.
1m
Third party

Time period to expire unused entries in the cache.

Type
Duration
Default
1m
Defined by
PulsarProperties$Producer$Cache
spring.pulsar.producer.cache.initial-capacityInitial size of cache.
50
Third party

Initial size of cache.

Type
Integer
Default
50
Defined by
PulsarProperties$Producer$Cache
spring.pulsar.producer.cache.maximum-sizeMaximum size of cache (entries).
1000
Third party

Maximum size of cache (entries).

Type
Long
Default
1000
Defined by
PulsarProperties$Producer$Cache
spring.pulsar.producer.chunking-enabledWhether to split large-size messages into multiple chunks.
false
Third party

Whether to split large-size messages into multiple chunks.

Type
Boolean
Default
false
Defined by
PulsarProperties$Producer
spring.pulsar.producer.compression-typeMessage compression type.
no default
Third party

Message compression type.

Type
CompressionType
Default
none
Defined by
PulsarProperties$Producer
spring.pulsar.producer.hashing-schemeMessage hashing scheme to choose the partition to which the message is published.
javastringhash
Third party

Message hashing scheme to choose the partition to which the message is published.

Type
HashingScheme
Default
javastringhash
Defined by
PulsarProperties$Producer
spring.pulsar.producer.message-routing-modeMessage routing mode for a partitioned producer.
roundrobinpartition
Third party

Message routing mode for a partitioned producer.

Type
MessageRoutingMode
Default
roundrobinpartition
Defined by
PulsarProperties$Producer
spring.pulsar.producer.nameName for the producer.
no default
Third party

Name for the producer. If not assigned, a unique name is generated.

Type
String
Default
none
Defined by
PulsarProperties$Producer
spring.pulsar.producer.send-timeoutTime before a message has to be acknowledged by the broker.
30s
Third party

Time before a message has to be acknowledged by the broker.

Type
Duration
Default
30s
Defined by
PulsarProperties$Producer
spring.pulsar.producer.topic-nameTopic the producer will publish to.
no default
Third party

Topic the producer will publish to.

Type
String
Default
none
Defined by
PulsarProperties$Producer
spring.pulsar.reader.nameReader name.
no default
Third party

Reader name.

Type
String
Default
none
Defined by
PulsarProperties$Reader
spring.pulsar.reader.read-compactedWhether to read messages from a compacted topic rather than a full message backlog of a topic.
false
Third party

Whether to read messages from a compacted topic rather than a full message backlog of a topic.

Type
Boolean
Default
false
Defined by
PulsarProperties$Reader
spring.pulsar.reader.subscription-nameSubscription name.
no default
Third party

Subscription name.

Type
String
Default
none
Defined by
PulsarProperties$Reader
spring.pulsar.reader.subscription-role-prefixPrefix of subscription role.
no default
Third party

Prefix of subscription role.

Type
String
Default
none
Defined by
PulsarProperties$Reader
spring.pulsar.reader.topicsTopics the reader subscribes to.
no default
Third party

Topics the reader subscribes to.

Type
List<String>
Default
none
Defined by
PulsarProperties$Reader
spring.pulsar.template.observations-enabledWhether to record observations for when the Observations API is available.
false
Third party

Whether to record observations for when the Observations API is available.

Type
Boolean
Default
false
Defined by
PulsarProperties$Template
spring.pulsar.transaction.enabledWhether transaction support is enabled.
false
Third party

Whether transaction support is enabled.

Type
Boolean
Default
false
Defined by
PulsarProperties$Transaction

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.

:information_source: Note

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>
...