Server-side Sessions - Redis
If you don’t wish to use the native container’s strategy for session replication, you can use CAS’s support for Redis session replication.
This feature is enabled via the following module:
1
2
3
4
5
<dependency>
<groupId>org.apereo.cas</groupId>
<artifactId>cas-server-support-session-redis</artifactId>
<version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-support-session-redis:${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-session-redis"
}
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-session-redis"
}
The following settings and properties are available from the CAS configuration catalog:
spring.redis.client-name
spring.redis.client-type
spring.redis.cluster.max-redirects
spring.redis.cluster.nodes
spring.redis.connect-timeout
spring.redis.database
spring.redis.host
spring.redis.jedis.pool.enabled
spring.redis.jedis.pool.max-active
spring.redis.jedis.pool.max-idle
spring.redis.jedis.pool.max-wait
spring.redis.jedis.pool.min-idle
spring.redis.jedis.pool.time-between-eviction-runs
spring.redis.lettuce.cluster.refresh.adaptive
spring.redis.lettuce.cluster.refresh.dynamic-refresh-sources
spring.redis.lettuce.cluster.refresh.period
spring.redis.lettuce.pool.enabled
spring.redis.lettuce.pool.max-active
spring.redis.lettuce.pool.max-idle
spring.redis.lettuce.pool.max-wait
spring.redis.lettuce.pool.min-idle
spring.redis.lettuce.pool.time-between-eviction-runs
spring.redis.lettuce.shutdown-timeout
spring.redis.password
spring.redis.port
spring.redis.sentinel.master
spring.redis.sentinel.nodes
spring.redis.sentinel.password
spring.redis.sentinel.username
spring.redis.ssl
spring.redis.timeout
spring.redis.url
spring.redis.username
spring.session.redis.cleanup-cronCron expression for expired session cleanup job.
Cron expression for expired session cleanup job. Only supported when repository-type is set to indexed. Not supported with a reactive session repository.
spring.session.redis.configure-actionThe configure action to apply when no user-defined ConfigureRedisAction or ConfigureReactiveRedisAction bean is present.
The configure action to apply when no user-defined ConfigureRedisAction or ConfigureReactiveRedisAction bean is present.
spring.session.redis.flush-modeSessions flush mode.
Sessions flush mode. Determines when session changes are written to the session store. Not supported with a reactive session repository.
spring.session.redis.namespaceNamespace for keys used to store sessions.
Namespace for keys used to store sessions.
spring.session.redis.repository-typeType of Redis session repository to configure.
Type of Redis session repository to configure.
spring.session.redis.save-modeSessions save mode.
Sessions save mode. Determines how session changes are tracked and saved to the session store.
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.
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.