Ignite Ticket Registry

Ignite integration is enabled by including the following dependency in the WAR overlay:

implementation "org.apereo.cas:cas-server-support-ignite-ticket-registry:${project.'cas.version'}"
<dependency>
  <groupId>org.apereo.cas</groupId>
  <artifactId>cas-server-support-ignite-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-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:

The configuration settings listed below are tagged as Required in the CAS configuration metadata. This flag indicates that the presence of the setting is not strictly necessary in the end-user CAS configuration, because a default value may be assigned or the feature in question may not be immediately intended for use. You may want to own the setting and update it assigned value, assuming the intended feature controlled by the setting is utilized.

  • cas.ticket.registry.ignite.ignite-address=
  • Used by TcpDiscoveryVmIpFinder which is an IP Finder which works only with pre-configured list of IP addresses specified via this setting. By default, this IP finder is not shared, which means that all grid nodes have to be configured with the same list of IP addresses when this IP finder is used. Parses provided values and initializes the internal collection of addresses. Addresses may be represented as follows:

    • IP address (e.g. 127.0.0.1, 9.9.9.9, etc);
    • IP address and port (e.g. 127.0.0.1:47500, 9.9.9.9:47501, etc);
    • IP address and port range (e.g. 127.0.0.1:47500..47510, 9.9.9.9:47501..47504, etc);
    • Hostname (e.g. host1.com, host2, etc);
    • Hostname and port (e.g. host1.com:47500, host2:47502, etc).
    • Hostname and port range (e.g. host1.com:47500..47510, host2:47502..47508, etc).
    If port is 0 or not provided then default port will be used (depends on discovery SPI configuration). If port range is provided (e.g. host:port1..port2) the following should be considered:
    • port1 < port2 should be true;
    • Both port1 and port2 should be greater than 0.

  • cas.ticket.registry.ignite.local-port=-1
  • Sets local port to listen to.

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

  • 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 TcpDiscoverySpi is started in server mode regardless of IgniteConfiguration.isClientMode().

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

  • 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 InetAddress.getLocalHost() will be used.

  • cas.ticket.registry.ignite.network-timeout=PT5S
  • Sets maximum network timeout to use for network operations.

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

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

    • ATOMIC: Specifies atomic-only cache behaviour. In this mode distributed transactions and distributed locking are not supported. Disabling transactions and locking allows to achieve much higher performance and throughput ratios. In addition to transactions and locking, one of the main differences in ATOMIC mode is that bulk writes, such as putAll(...), removeAll(...), and transformAll(...) methods, become simple batch operations which can partially fail. In case of partial failure CachePartialUpdateCheckedException will be thrown which will contain a list of keys for which the update failed. It is recommended that bulk writes are used whenever multiple keys need to be inserted or updated in cache, as they reduce number of network trips and provide better performance. Note that even without locking and transactions, ATOMIC mode still provides full consistency guarantees across all cache nodes. Also note that all data modifications in ATOMIC mode are guaranteed to be atomic and consistent with writes to the underlying persistent store, if one is configured.
    • TRANSACTIONAL: Specifies fully ACID-compliant transactional cache behavior.

  • cas.ticket.registry.ignite.tickets-cache.cache-mode=REPLICATED
  • Specified the caching mode.

    • LOCAL: Specifies local-only cache behaviour. In this mode caches residing on different grid nodes will not know about each other. Other than distribution, local caches still have all the caching features, such as eviction, expiration, swapping, querying, etc... This mode is very useful when caching read-only data or data that automatically expires at a certain interval and then automatically reloaded from persistence store.
    • REPLICATED: Specifies fully replicated cache behavior. In this mode all the keys are distributed to all participating nodes. User still has affinity control over subset of nodes for any given key via AffinityFunction configuration.
    • PARTITIONED: Specifies partitioned cache behaviour. In this mode the overall key set will be divided into partitions and all partitions will be split equally between participating nodes. User has affinity control over key assignment via AffinityFunction configuration. Note that partitioned cache is always fronted by local 'near' cache which stores most recent data. You can configure the size of near cache via NearCacheConfiguration.getNearEvictionPolicy() configuration property.

  • 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</code>, 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.

    • FULL_ASYNC: Flag indicating that Ignite will not wait for write or commit responses from participating nodes, which means that remote nodes may get their state updated a bit after any of the cache write methods complete, or after Transaction.commit() method completes.
    • FULL_SYNC: Flag indicating that Ignite should wait for write or commit replies from all nodes. This behavior guarantees that whenever any of the atomic or transactional writes complete, all other participating nodes which cache the written data have been updated.
    • PRIMARY_SYNC: This flag only makes sense for CacheMode.PARTITIONED mode. When enabled, Ignite will wait for write or commit to complete on primary node, but will not wait for backups to be updated.

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


    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. Over time and with community contributions, the accuracy and volume of the documentation should improve over time.

    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 below 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.S ettings 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.

    Time Unit of Measure

    All CAS settings that deal with time units, unless noted otherwise, should support the duration syntax for full clarity on unit of measure: PT20S, PT15M, PT10H, PT6D, P2DT3H4M.

    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.