Memcached Ticket Registry

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

<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-memcached-ticket-registry</artifactId>
    <version>${cas.version}</version>
</dependency>

implementation "org.apereo.cas:cas-server-support-memcached-ticket-registry:${project.'cas.version'}"

dependencyManagement {
    imports {
        mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
    }
}

dependencies {
    implementation "org.apereo.cas:cas-server-support-memcached-ticket-registry"
}

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-memcached-ticket-registry"
}

Usage

This feature is deprecated and is scheduled to be removed in the future.

This registry stores tickets in one or more memcached instances. Memcached stores data in exactly one node among many in a distributed cache, thus avoiding the requirement to replicate or otherwise share data between nodes. A deterministic function is used to locate the node, N’, on which to store key K:

N' = f(h(K), N1, N2, N3, ... Nm)

where h(K) is the hash of key K, N1 … Nm is the set of cache nodes, and N’ ∈ N … Nm.

The function is deterministic in that it consistently produces the same result for a given key and set of cache nodes. Note that a change in the set of available cache nodes may produce a different target node on which to store the key.

The actual memcached implementation may be supported via one of the following options, expected to be defined in the overlay.

Usage Warning!

Not all ticket registry operations are supported by the memcached ticket registry implementation. In particular, operations that execute bulk queries such as deleting and fetching all tickets in a single request may be unsupported, as memcached itself is rather unable to process and support that type of query.

Spymemcached

Enable support via the spymemcached library. This is a simple, asynchronous, single-threaded memcached client that should be the default choice for the majority of deployments.

Support is enabled by including the following dependency in the WAR overlay:

<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-memcached-spy</artifactId>
    <version>${cas.version}</version>
</dependency>

implementation "org.apereo.cas:cas-server-support-memcached-spy:${project.'cas.version'}"

dependencyManagement {
    imports {
        mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
    }
}

dependencies {
    implementation "org.apereo.cas:cas-server-support-memcached-spy"
}

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-memcached-spy"
}

AWS ElastiCache

You may also use AWS ElastiCache which is a web service that makes it easy to set up, manage, and scale a distributed in-memory data store or cache environment in the cloud. It provides a high-performance, scalable, and cost-effective caching solution, while removing the complexity associated with deploying and managing a distributed cache environment.

For clusters running the Memcached engine, ElastiCache supports Auto Discovery—the ability for client programs to automatically identify all of the nodes in a cache cluster, and to initiate and maintain connections to all of these nodes. With Auto Discovery, CAS does not need to manually connect to individual cache nodes; instead, CAS connects to one Memcached node and retrieves the list of nodes. From that list, CAS is aware of the rest of the nodes in the cluster and can connect to any of them. You do not need to hard code the individual cache node endpoints in the configuration

All of the cache nodes in the cluster maintain a list of metadata about all of the other nodes. This metadata is updated whenever nodes are added or removed from the cluster.

Support is enabled by including the following dependency in the WAR overlay:

<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-memcached-aws-elasticache</artifactId>
    <version>${cas.version}</version>
</dependency>

implementation "org.apereo.cas:cas-server-support-memcached-aws-elasticache:${project.'cas.version'}"

dependencyManagement {
    imports {
        mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
    }
}

dependencies {
    implementation "org.apereo.cas:cas-server-support-memcached-aws-elasticache"
}

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-memcached-aws-elasticache"
}

Configuration Considerations

There are three core configuration concerns with memcached:

Hash Algorithm
Node locator strategy
Object serialization mechanism

Hash Algorithm

The hash algorithm is used to transform a key value into a memcached storage key that uniquely identifies the corresponding value. The choice of hashing algorithm has implications for failover behavior that is important for HA deployments. The FNV1_64_HASH algorithm is recommended since it offers a nice balance of speed and low collision rate; see the javadocs for alternatives.

Node Locator

The node locator serves as the deterministic node selection function for the memcached client provided by the underlying spymemcached library. There are two choices:

The array modulus mechanism is the default and suitable for cases when the number of nodes in the memcached pool is expected to be consistent. The algorithm computes an index into the array of memcached nodes:

hash(key) % length(nodes)

Obviously the selected index is a function of the number of memcached nodes, so variance in number of nodes produces variance in the node selected to store the key, which is undesirable.

The consistent strategy generally provides a target node that does not vary with the number of nodes. This strategy should be used in cases where the memcached pool may grow or shrink dynamically, including due to frequent node failure.

Object Serialization

Memcached stores bytes of data, so CAS tickets must be serialized to a byte array prior to storage. CAS ships with a custom serialization component KryoTranscoder based on the Kryo serialization framework. This component is recommended over the default Java serialization mechanism since it produces much more compact data, which benefits both storage requirements and throughput.

Configuration

The following settings and properties are available from the CAS configuration catalog:

cas.ticket.registry.memcached.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.memcached.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.memcached.serversComma-separated list of memcached servers.

localhost:11211

Required

Comma-separated list of memcached servers.

Type: String
Default: localhost:11211
Defined by: MemcachedTicketRegistryProperties

cas.ticket.registry.memcached.crypto.algThe signing/encryption algorithm to use.

AES

The signing/encryption algorithm to use.

Type: String
Default: AES
Defined by: EncryptionRandomizedSigningJwtCryptographyProperties

cas.ticket.registry.memcached.crypto.enabledWhether crypto operations are enabled.

true

Whether crypto operations are enabled.

Type: Boolean
Default: true
Defined by: EncryptionRandomizedSigningJwtCryptographyProperties

cas.ticket.registry.memcached.crypto.encryption.key-sizeEncryption key size.

16

Encryption key size.

Type: Integer
Default: 16
Defined by: EncryptionRandomizedCryptoProperties

cas.ticket.registry.memcached.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.memcached.crypto.signing.key-sizeThe signing key size.

512

The signing key size.

Type: Integer
Default: 512
Defined by: SigningJwtCryptoProperties

cas.ticket.registry.memcached.daemonSet the daemon state of the IO thread (defaults to true).

true

Set the daemon state of the IO thread (defaults to true).

Type: Boolean
Default: true
Defined by: MemcachedTicketRegistryProperties

cas.ticket.registry.memcached.failure-modeFailure mode.

Redistribute

Failure mode. Acceptable values are Redistribute,Retry,Cancel.

Type: String
Default: Redistribute
Defined by: MemcachedTicketRegistryProperties

cas.ticket.registry.memcached.hash-algorithmHash algorithm.

FNV1_64_HASH

Hash algorithm. Acceptable values are NATIVE_HASH,CRC_HASH,FNV1_64_HASH,FNV1A_64_HASH,FNV1_32_HASH,FNV1A_32_HASH,KETAMA_HASH.

Type: String
Default: FNV1_64_HASH
Defined by: MemcachedTicketRegistryProperties

cas.ticket.registry.memcached.kryo-auto-resetIf true, reset is called automatically after an entire object graph has been read or written.

false

If true, reset is called automatically after an entire object graph has been read or written. If false, reset must be called manually, which allows unregistered class names, references, and other information to span multiple object graphs.

Type: Boolean
Default: false
Defined by: MemcachedTicketRegistryProperties

cas.ticket.registry.memcached.kryo-objects-by-referenceIf true, each appearance of an object in the graph after the first is stored as an integer ordinal.

false

If true, each appearance of an object in the graph after the first is stored as an integer ordinal. When set to true, MapReferenceResolver is used. This enables references to the same object and cyclic graphs to be serialized, but typically adds overhead of one byte per object.

Type: Boolean
Default: false
Defined by: MemcachedTicketRegistryProperties

cas.ticket.registry.memcached.kryo-registration-requiredIf true, an exception is thrown when an unregistered class is encountered.

true

If true, an exception is thrown when an unregistered class is encountered.

If false, when an unregistered class is encountered, its fully qualified class name will be serialized and the default serializer for the class used to serialize the object. Subsequent appearances of the class within the same object graph are serialized as an int id. Registered classes are serialized as an int id, avoiding the overhead of serializing the class name, but have the drawback of needing to know the classes to be serialized up front. See ComponentSerializationPlan for help here.

Type: Boolean
Default: true
Defined by: MemcachedTicketRegistryProperties

cas.ticket.registry.memcached.locator-typeLocator mode.

ARRAY_MOD

Locator mode. Acceptable values are ARRAY_MOD, CONSISTENT, VBUCKET.

Type: String
Default: ARRAY_MOD
Defined by: MemcachedTicketRegistryProperties

cas.ticket.registry.memcached.max-idleSet the value for the maxTotal configuration attribute for pools created with this configuration instance.

8

Set the value for the maxTotal configuration attribute for pools created with this configuration instance.

Type: Integer
Default: 8
Defined by: MemcachedTicketRegistryProperties

cas.ticket.registry.memcached.max-reconnect-delaySet the maximum reconnect delay.

-1

Set the maximum reconnect delay.

Type: Long
Default: -1
Defined by: MemcachedTicketRegistryProperties

cas.ticket.registry.memcached.max-totalSets the cap on the number of objects that can be allocated by the pool (checked out to clients, or idle awaiting checkout) at a given time.

20

Sets the cap on the number of objects that can be allocated by the pool (checked out to clients, or idle awaiting checkout) at a given time. Use a negative value for no limit.

Type: Integer
Default: 20
Defined by: MemcachedTicketRegistryProperties

cas.ticket.registry.memcached.min-idleGet the value for the minIdle configuration attribute for pools created with this configuration instance.

0

Get the value for the minIdle configuration attribute for pools created with this configuration instance.

Type: Integer
Default: 0
Defined by: MemcachedTicketRegistryProperties

cas.ticket.registry.memcached.op-timeoutSet the default operation timeout in milliseconds.

-1

Set the default operation timeout in milliseconds.

Type: Long
Default: -1
Defined by: MemcachedTicketRegistryProperties

cas.ticket.registry.memcached.protocolProtocol.

TEXT

Protocol. Acceptable values are TEXT, BINARY.

Type: String
Default: TEXT
Defined by: MemcachedTicketRegistryProperties

cas.ticket.registry.memcached.should-optimizeSet to false if the default operation optimization is not desirable.

false

Set to false if the default operation optimization is not desirable.

Type: Boolean
Default: false
Defined by: MemcachedTicketRegistryProperties

cas.ticket.registry.memcached.shutdown-timeout-secondsThe number of seconds to wait for connections to finish before shutting down the client.

-1

The number of seconds to wait for connections to finish before shutting down the client.

Type: Long
Default: -1
Defined by: MemcachedTicketRegistryProperties

cas.ticket.registry.memcached.timeout-exception-thresholdSet the maximum timeout exception threshold.

2

Set the maximum timeout exception threshold.

Type: Integer
Default: 2
Defined by: MemcachedTicketRegistryProperties

cas.ticket.registry.memcached.transcoderIndicate the transcoder type.

KRYO

Indicate the transcoder type. Available values are as follows:

KRYO: CAS transcoder implementation based on Kryo fast serialization framework suited for efficient serialization of tickets. Provides pooling mechanisms as well as control over object registration and sequences.
SERIAL: Kryo native transcoder that serializes and compresses objects.
WHALIN: Transcoder that provides compatibility with Greg Whalin's memcached client.
WHALINV1: Handles old whalin encoding: data type is in the first byte of the value.

Type: BaseMemcachedProperties.TranscoderTypes
Default: KRYO
Defined by: MemcachedTicketRegistryProperties

cas.ticket.registry.memcached.transcoder-compression-thresholdFor transcoders other than kryo, determines the compression threshold.

16384

For transcoders other than kryo, determines the compression threshold. Does not apply to kryo.

Type: Integer
Default: 16384
Defined by: MemcachedTicketRegistryProperties

cas.ticket.registry.memcached.use-nagle-algorithmSet to true if you'd like to enable the Nagle algorithm.

false

Set to true if you'd like to enable the Nagle algorithm.

Type: Boolean
Default: false
Defined by: MemcachedTicketRegistryProperties

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:

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:

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

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.

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.

High Availability Considerations

Memcached does not provide for replication by design, but the client is tolerant to node failures with failureMode="Redistribute". In this mode a write failure will cause the client to flag the node as failed and remove it from the set of available nodes. It subsequently recomputes the node location function with the reduced node set to find a new node on which to store the key. If the node location function selects the same node, which is likely for the CONSISTENT strategy, a backup node will be computed. The value is written to and read from the failover node until the primary node recovers. The client will periodically check the failed node for liveliness and restore it to the node pool as soon as it recovers. When the primary node is resurrected, if it contains a value for a particular key, it would supersede the value known to the failover node. The most common effect on CAS behavior in this circumstance would occur when ticket-granting tickets have duplicate values, which could affect single sign-out and prevent access to services. In particular, services accessed and forced authentications that occur while the failover service is active would be lost when the failed node recovers. In most cases this behavior is tolerable, but it can be avoided by restarting the memcached service on the failed node prior to rejoining the cache pool.

A read failure in Redistribute mode causes the node to be removed from the set of available nodes, a failover node is computed, and a value is read from that node. In most cases this results in a key not found situation. The effect on CAS behavior depends on the type of ticket requested:

Service ticket - Service access would be denied for the requested ticket, but permitted for subsequent attempts since a new ticket would be generated and validated.
Ticket-granting ticket - The SSO session would be terminated and re-authentication would be required.

Read failures are thus entirely innocuous for environments where re-authentication is acceptable.