Ignite Ticket Registry
Ignite integration is enabled by including the following dependency in the WAR overlay:
1
2
3
4
5
<dependency>
<groupId>org.apereo.cas</groupId>
<artifactId>cas-server-support-ignite-ticket-registry</artifactId>
<version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-support-ignite-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-ignite-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-ignite-ticket-registry"
}
This registry stores tickets in an Ignite instance.
Distributed Cache
Distributed caches are recommended for HA architectures since they offer fault tolerance in the ticket storage subsystem.
TLS Replication
Ignite supports replication over TLS for distributed caches composed of two or more nodes. To learn more about TLS replication with Ignite, see this resource.
Configuration
The following settings and properties are available from the CAS configuration catalog:
cas.ticket.registry.ignite.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.ignite.crypto.signing.key=
The signing key is a JWT whose length is defined by the signing key size setting.
|
cas.ticket.registry.ignite.ignite-address=
Used by
|
cas.ticket.registry.ignite.local-port=-1
Sets local port to listen to.
|
cas.ticket.registry.ignite.crypto.alg=AES
The signing/encryption algorithm to use.
|
cas.ticket.registry.ignite.crypto.enabled=true
Whether crypto operations are enabled.
|
cas.ticket.registry.ignite.crypto.encryption.key-size=16
Encryption key size.
|
cas.ticket.registry.ignite.crypto.signing.key-size=512
The signing key size.
|
cas.ticket.registry.ignite.ack-timeout=PT2S
Sets timeout for receiving acknowledgement for sent message. If acknowledgement is not received within this timeout, sending is considered as failed and SPI tries to repeat message sending. This settings supports the
|
cas.ticket.registry.ignite.client-mode=false
Start in client mode. If true the local node is started as a client.
|
cas.ticket.registry.ignite.default-persistence-enabled=false
Ignite native persistence is a distributed ACID and SQL-compliant disk store that transparently integrates with Ignite's durable memory. Ignite persistence is optional and can be turned on and off. When turned off Ignite becomes a pure in-memory store. With the native persistence enabled, Ignite always stores a superset of data on disk, and as much as it can in RAM based on the capacity of the latter. For example, if there are 100 entries and RAM has the capacity to store only 20, then all 100 will be stored on disk and only 20 will be cached in RAM for better performance. Also, it is worth mentioning that as with a pure in-memory use case, when the persistence is turned on, every individual cluster node persists only a subset of the data, only including partitions for which the node is either primary or backup. Collectively, the whole cluster contains the full data set.
|
cas.ticket.registry.ignite.default-region-max-size=0
By default, Ignite nodes consume up to 20% of the RAM available locally, and in most cases, ​this is the only parameter you might need to change. Using the below setting allows you to change the default region memory size.
|
cas.ticket.registry.ignite.force-server-mode=false
Sets force server mode flag. If true
|
cas.ticket.registry.ignite.join-timeout=PT1S
Sets join timeout. If non-shared IP finder is used and node fails to connect to any address from IP finder, node keeps trying to join within this timeout. If all addresses are still unresponsive, exception is thrown and node startup fails. This settings supports the
|
cas.ticket.registry.ignite.key-algorithm=SunX509
The key algorithm to use when creating SSL context.
|
cas.ticket.registry.ignite.key-store-file-path=
Keystore file path used to create a SSL context for the ticket registry.
|
cas.ticket.registry.ignite.key-store-password=
Keystore password used to create a SSL context for the ticket registry.
|
cas.ticket.registry.ignite.key-store-type=JKS
Keystore type used to create a SSL context for the ticket registry.
|
cas.ticket.registry.ignite.local-address=
Sets local host IP address that discovery SPI uses. If not provided, by default a first found non-loopback address will be used. If there is no non-loopback address available, then
|
cas.ticket.registry.ignite.network-timeout=PT5S
Sets maximum network timeout to use for network operations. This settings supports the
|
cas.ticket.registry.ignite.protocol=TLS
SSL protocol used to create a SSL context for the ticket registry.
|
cas.ticket.registry.ignite.socket-timeout=PT5S
Sets socket operations timeout. This timeout is used to limit connection time and write-to-socket time. Note that when running Ignite on Amazon EC2, socket timeout must be set to a value significantly greater than the default (e.g. to 30000). This settings supports the
|
cas.ticket.registry.ignite.thread-priority=10
Sets thread priority. All threads within SPI will be started with it.
|
cas.ticket.registry.ignite.tickets-cache.atomicity-mode=TRANSACTIONAL
Specifies the atomicity mode.
|
cas.ticket.registry.ignite.tickets-cache.cache-mode=REPLICATED
Specified the caching mode.
|
cas.ticket.registry.ignite.tickets-cache.write-synchronization-mode=FULL_SYNC
Mode indicating how Ignite should wait for write replies from other nodes. Default value is FULL_ASYNC}, which means that Ignite will not wait for responses from participating nodes. This means that by default remote nodes may get their state updated slightly after any of the cache write methods complete, or after Transaction.commit() method completes.
|
cas.ticket.registry.ignite.trust-store-file-path=
Truststore file path used to create a SSL context for the ticket registry.
|
cas.ticket.registry.ignite.trust-store-password=
Truststore password used to create a SSL context for the ticket registry.
|
cas.ticket.registry.ignite.trust-store-type=JKS
Truststore type used to create a SSL context for the ticket registry.
|
cas.ticket.registry.ignite.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.ignite.crypto.signing.key=
The signing key is a JWT whose length is defined by the signing key size setting.
|
cas.ticket.registry.ignite.crypto.alg=AES
The signing/encryption algorithm to use.
|
cas.ticket.registry.ignite.crypto.enabled=true
Whether crypto operations are enabled.
|
cas.ticket.registry.ignite.crypto.encryption.key-size=16
Encryption key size.
|
cas.ticket.registry.ignite.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.
Troubleshooting
- You will need to ensure that network communication across CAS nodes is allowed and no firewall or other component is blocking traffic.
- If nodes external to CAS instances are utilized, ensure that each cache manager specifies a name that matches the Ignite configuration itself.
- You may also need to adjust your expiration policy to allow for a larger time span, specially for service tickets depending on network traffic and communication delay across CAS nodes particularly in the event that a node is trying to join the cluster.