APEREO CASDocumentation

Enterprise Authentication for All Earthlings and Beyond

Identity, Single Sign-On and Access Management
View on GitHub

Redis Throttling Authentication Attempts

Queries a Redis data source used by the CAS audit facility to prevent successive failed login attempts for a particular username from the same IP address. This component requires and depends on the CAS auditing functionality via Redis.

Enable the following module in your configuration overlay:



1
2
3
4
5



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





1



implementation "org.apereo.cas:cas-server-support-throttle-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-throttle-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-throttle-redis"
}

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

cas.audit.redis.cluster.nodes[0].hostServer's host address.
no default
Required

Server's host address.

Type
String
Default
none
Defined by
RedisClusterNodeProperties
cas.audit.redis.cluster.nodes[0].portServer's port number.
no default
Required

Server's port number.

Type
int
Default
none
Defined by
RedisClusterNodeProperties
cas.audit.redis.cluster.nodes[0].replica-ofSet the id of the master node.
no default
Required

Set the id of the master node.

Type
String
Default
none
Defined by
RedisClusterNodeProperties
cas.audit.redis.cluster.nodes[0].typeIndicate the type/role of this node.
no default
Required

Indicate the type/role of this node. Accepted values are: MASTER, REPLICA.

Type
String
Default
none
Defined by
RedisClusterNodeProperties
cas.audit.redis.cluster.passwordThe cluster connection's password.
no default
Required

The cluster connection's password.

Type
String
Default
none
Defined by
RedisClusterProperties
cas.audit.redis.cluster.usernameThe cluster connection's username.
no default
Required

The cluster connection's username.

Type
String
Default
none
Defined by
RedisClusterProperties
cas.audit.redis.databaseDatabase index used by the connection factory.
0
Required

Database index used by the connection factory.

Type
Integer
Default
0
Defined by
AuditRedisProperties
cas.audit.redis.enabledWhether the module is enabled or not, defaults to true.
true
Required

Whether the module is enabled or not, defaults to true.

Type
Boolean
Default
true
Defined by
AuditRedisProperties
cas.audit.redis.hostRedis server host.
localhost
Required

Redis server host.

Type
String
Default
localhost
Defined by
AuditRedisProperties
cas.audit.redis.passwordLogin password of the redis server.
no default
Required

Login password of the redis server.

Type
String
Default
none
Defined by
AuditRedisProperties
cas.audit.redis.pool.enabledEnable the pooling configuration.
false
Required

Enable the pooling configuration.

Type
Boolean
Default
false
Defined by
RedisPoolProperties
cas.audit.redis.portRedis server port.
6379
Required

Redis server port.

Type
Integer
Default
6379
Defined by
AuditRedisProperties
cas.audit.redis.sentinel.masterName of Redis server.
no default
Required

Name of Redis server.

Type
String
Default
none
Defined by
RedisSentinelProperties
cas.audit.redis.usernameLogin username of the redis server.
no default
Required

Login username of the redis server.

Type
String
Default
none
Defined by
AuditRedisProperties
cas.audit.redis.asynchronousExecute the recording of audit records in async manner.
true

Execute the recording of audit records in async manner. This setting must almost always be set to true.

Type
Boolean
Default
true
Defined by
AuditRedisProperties
cas.audit.redis.certificate-fileMay be used when making SSL connections to build the trust manager.
no default

May be used when making SSL connections to build the trust manager. Sets the certificate file to use for client authentication. This is typically an X.509 certificate file (or chain file) in PEM format.

Type
File
Default
none
Defined by
AuditRedisProperties
cas.audit.redis.cluster.dynamic-refresh-sourcesWhether to discover and query all cluster nodes for obtaining the cluster topology.
true

Whether to discover and query all cluster nodes for obtaining the cluster topology. When set to false, only the initial seed nodes are used as sources for topology discovery.

Type
Boolean
Default
true
Defined by
RedisClusterProperties
cas.audit.redis.cluster.max-redirectsThe max number of redirects to follow.
0

The max number of redirects to follow.

Type
Integer
Default
0
Defined by
RedisClusterProperties
cas.audit.redis.cluster.nodesList of nodes available in the redis cluster.
no default

List of nodes available in the redis cluster.

Type
List<RedisClusterNodeProperties>
Default
none
Defined by
RedisClusterProperties
cas.audit.redis.cluster.nodes[0].idIdentifier of this node.
no default

Identifier of this node.

Type
String
Default
none
Defined by
RedisClusterNodeProperties
cas.audit.redis.cluster.nodes[0].nameName of this node.
no default

Name of this node.

Type
String
Default
none
Defined by
RedisClusterNodeProperties
cas.audit.redis.cluster.topology-refresh-periodEnables periodic refresh of cluster topology and sets the refresh period.
no default
Duration

Enables periodic refresh of cluster topology and sets the refresh period.

Type
String
Default
none
Defined by
RedisClusterProperties
cas.audit.redis.connect-timeoutConnection timeout.
PT10S
Duration

Connection timeout.

Type
String
Default
PT10S
Defined by
AuditRedisProperties
cas.audit.redis.keep-alive-countThe maximum number of keepalive probes TCP should send before dropping the connection.
0

The maximum number of keepalive probes TCP should send before dropping the connection. By default, leaving this number at zero disables keepalive.

Type
Integer
Default
0
Defined by
AuditRedisProperties
cas.audit.redis.keep-alive-idle-timeoutThe time the connection needs to remain idle before TCP starts sending keepalive probes if keepalive is enabled.
PT2H
Duration

The time the connection needs to remain idle before TCP starts sending keepalive probes if keepalive is enabled.

Type
String
Default
PT2H
Defined by
AuditRedisProperties
cas.audit.redis.keep-alive-intervalThe time the connection needs to remain idle before TCP starts sending keepalive probes.
PT60S
Duration

The time the connection needs to remain idle before TCP starts sending keepalive probes.

Type
String
Default
PT60S
Defined by
AuditRedisProperties
cas.audit.redis.key-certificate-chain-fileMay be used when making SSL connections to build the key manager.
no default

May be used when making SSL connections to build the key manager. Sets the key certificate file to use for client authentication. This is typically an X.509 certificate file (or chain file) in PEM format.

Type
File
Default
none
Defined by
AuditRedisProperties
cas.audit.redis.key-fileMay be used when making SSL connections.
no default

May be used when making SSL connections. Sets the key file for client authentication. The key is reloaded on each connection attempt that allows CAS to replace certificates during runtime. This is typically a PKCS#8 private key file in PEM format.

Type
File
Default
none
Defined by
AuditRedisProperties
cas.audit.redis.key-passwordThe password of the #keyFile , or null if it's not password-protected.
no default

The password of the #keyFile, or null if it's not password-protected.

Type
String
Default
none
Defined by
AuditRedisProperties
cas.audit.redis.pool.fairnessReturns whether or not the pool serves threads waiting to borrow objects fairly.
false

Returns whether or not the pool serves threads waiting to borrow objects fairly. True means that waiting threads are served as if waiting in a FIFO queue.

Type
Boolean
Default
false
Defined by
RedisPoolProperties
cas.audit.redis.pool.lifoReturns whether the pool has LIFO (last in, first out) behaviour with respect to idle objects - always returning the most recently used object from the pool, or as a FIFO (first in, first out) queue, where the pool al...
true

Returns whether the pool has LIFO (last in, first out) behaviour with respect to idle objects - always returning the most recently used object from the pool, or as a FIFO (first in, first out) queue, where the pool always returns the oldest object in the idle object pool.

Type
Boolean
Default
true
Defined by
RedisPoolProperties
cas.audit.redis.pool.max-activeMax number of connections that can be allocated by the pool at a given time.
8

Max number of connections that can be allocated by the pool at a given time. Use a negative value for no limit.

Type
Integer
Default
8
Defined by
RedisPoolProperties
cas.audit.redis.pool.max-idleMax number of "idle" connections in the pool.
8

Max number of "idle" connections in the pool. Use a negative value to indicate an unlimited number of idle connections.

Type
Integer
Default
8
Defined by
RedisPoolProperties
cas.audit.redis.pool.max-waitMaximum amount of time (in milliseconds) a connection allocation should block before throwing an exception when the pool is exhausted.
PT5S
Duration

Maximum amount of time (in milliseconds) a connection allocation should block before throwing an exception when the pool is exhausted. Use a negative value to block indefinitely.

Type
String
Default
PT5S
Defined by
RedisPoolProperties
cas.audit.redis.pool.min-evictable-idle-time-millisSets the minimum amount of time an object may sit idle in the pool before it is eligible for eviction by the idle object evictor (if any - see setTimeBetweenEvictionRunsMillis(long)).
0

Sets the minimum amount of time an object may sit idle in the pool before it is eligible for eviction by the idle object evictor (if any - see setTimeBetweenEvictionRunsMillis(long)). When non-positive, no objects will be evicted from the pool due to idle time alone.

Type
Long
Default
0
Defined by
RedisPoolProperties
cas.audit.redis.pool.min-idleTarget for the minimum number of idle connections to maintain in the pool.
0

Target for the minimum number of idle connections to maintain in the pool. This setting only has an effect if it is positive.

Type
Integer
Default
0
Defined by
RedisPoolProperties
cas.audit.redis.pool.num-tests-per-eviction-runSets the maximum number of objects to examine during each run (if any) of the idle object evictor thread.
0

Sets the maximum number of objects to examine during each run (if any) of the idle object evictor thread. When positive, the number of tests performed for a run will be the minimum of the configured value and the number of idle instances in the pool. When negative, the number of tests performed will be ceil(getNumIdle()/ abs(getNumTestsPerEvictionRun())) which means that when the value is -n roughly one nth of the idle objects will be tested per run.

Type
Integer
Default
0
Defined by
RedisPoolProperties
cas.audit.redis.pool.soft-min-evictable-idle-time-millisSets the minimum amount of time an object may sit idle in the pool before it is eligible for eviction by the idle object evictor (if any - see setTimeBetweenEvictionRunsMillis(long)), with the extra condition that at...
0

Sets the minimum amount of time an object may sit idle in the pool before it is eligible for eviction by the idle object evictor (if any - see setTimeBetweenEvictionRunsMillis(long)), with the extra condition that at least minIdle object instances remain in the pool. This setting is overridden by getMinEvictableIdleTimeMillis() (that is, if getMinEvictableIdleTimeMillis() is positive, then getSoftMinEvictableIdleTimeMillis() is ignored).

Type
Long
Default
0
Defined by
RedisPoolProperties
cas.audit.redis.pool.test-on-borrowReturns whether objects borrowed from the pool will be validated before being returned from the borrowObject() method.
false

Returns whether objects borrowed from the pool will be validated before being returned from the borrowObject() method. Validation is performed by the validateObject() method of the factory associated with the pool. If the object fails to validate, it will be removed from the pool and destroyed, and a new attempt will be made to borrow an object from the pool.

Type
Boolean
Default
false
Defined by
RedisPoolProperties
cas.audit.redis.pool.test-on-createReturns whether objects created for the pool will be validated before being returned from the borrowObject() method.
false

Returns whether objects created for the pool will be validated before being returned from the borrowObject() method. Validation is performed by the validateObject() method of the factory associated with the pool. If the object fails to validate, then borrowObject() will fail.

Type
Boolean
Default
false
Defined by
RedisPoolProperties
cas.audit.redis.pool.test-on-returnReturns whether objects borrowed from the pool will be validated when they are returned to the pool via the returnObject() method.
false

Returns whether objects borrowed from the pool will be validated when they are returned to the pool via the returnObject() method. Validation is performed by the validateObject() method of the factory associated with the pool. Returning objects that fail validation are destroyed rather then being returned the pool.

Type
Boolean
Default
false
Defined by
RedisPoolProperties
cas.audit.redis.pool.test-while-idleReturns whether objects sitting idle in the pool will be validated by the idle object evictor ( if any - see setTimeBetweenEvictionRunsMillis(long)).
false

Returns whether objects sitting idle in the pool will be validated by the idle object evictor ( if any - see setTimeBetweenEvictionRunsMillis(long)). Validation is performed by the validateObject() method of the factory associated with the pool. If the object fails to validate, it will be removed from the pool and destroyed.

Type
Boolean
Default
false
Defined by
RedisPoolProperties
cas.audit.redis.pool.time-between-eviction-runs-millisSets the amount of time (in milliseconds) between runs of the idle object evictor thread.
-1

Sets the amount of time (in milliseconds) between runs of the idle object evictor thread. When non-positive, no idle object evictor thread will be run. If positive, the idle object evictor thread will run at least once every timeBetweenEvictionRunsMillis milliseconds, and will attempt to evict objects from the pool that are idle longer than getMinEvictableIdleTimeMillis() (if positive) or getSoftMinEvictableIdleTimeMillis() (if positive).

Type
Long
Default
-1
Defined by
RedisPoolProperties
cas.audit.redis.protocol-versionRedis protocol version.
RESP3

Redis protocol version.

Type
String
Default
RESP3
Defined by
AuditRedisProperties
cas.audit.redis.read-fromSetting that describes how Lettuce routes read operations to replica nodes.
no default
Setting that describes how Lettuce routes read operations to replica nodes. Note that modes referencing MASTER/SLAVE are deprecated (but still supported) in the Lettuce redis client dependency so migrate config to UPSTREAM/REPLICA. Available values are as follows:
  • UPSTREAM: Read from the current upstream node.
  • UPSTREAMPREFERRED: Read from the upstream node, but if it is unavailable, read from replica nodes.
  • MASTER: Read from the current upstream node.
  • MASTERPREFERRED: Read from the upstream node, but if it is unavailable, read from replica nodes.
  • SLAVE: Read from replica nodes.
  • SLAVEPREFERRED: Read from the replica nodes, but if none is unavailable, read from the upstream node.
  • REPLICA: Read from replica nodes.
  • REPLICAPREFERRED: Read from the replica nodes, but if none is unavailable, read from the upstream node.
  • ANY: Read from any node of the cluster.
  • ANYREPLICA: Read from any replica node of the cluster.
  • NEAREST: Read from the nearest node.
Type
BaseRedisProperties.RedisReadFromTypes
Default
none
Defined by
AuditRedisProperties
cas.audit.redis.sentinel.nodelist of host:port pairs.
no default

list of host:port pairs.

Type
List<String>
Default
none
Defined by
RedisSentinelProperties
cas.audit.redis.sentinel.passwordLogin password of the sentinel server.
no default

Login password of the sentinel server.

Type
String
Default
none
Defined by
RedisSentinelProperties
cas.audit.redis.share-native-connectionsThe shared native connection is never closed by Lettuce connection, therefore it is not validated by default when connections are retrieved.
no default

The shared native connection is never closed by Lettuce connection, therefore it is not validated by default when connections are retrieved. If this setting is true, a shared connection will be used for regular operations and a connection provider will be used to select a connection for blocking and tx operations only, which should not share a connection. If native connection sharing is disabled, new (or pooled) connections will be used for all operations. By default, multiple connections share a single thread-safe native connection. If you enable connection pooling, then native connection sharing will be disabled and the connection pool will be used for all operations. You may however explicitly control connection sharing via this setting as an override.

Type
Boolean
Default
none
Defined by
AuditRedisProperties
cas.audit.redis.start-tlsStart mutual TLS.
false

Start mutual TLS. In order to support TLS, Redis should be configured with a X.509 certificate and a private key. In addition, it is necessary to specify a CA certificate bundle file or path to be used as a trusted root when validating certificates.

Type
Boolean
Default
false
Defined by
AuditRedisProperties
cas.audit.redis.timeoutCommand timeout.
PT60S
Duration

Command timeout.

Type
String
Default
PT60S
Defined by
AuditRedisProperties
cas.audit.redis.uriDatabase URI.
no default

Database URI.

Type
String
Default
none
Defined by
AuditRedisProperties
cas.audit.redis.use-sslWhether or not to use SSL for connection factory.
false

Whether or not to use SSL for connection factory.

Type
Boolean
Default
false
Defined by
AuditRedisProperties
cas.audit.redis.verify-peerControl how peer verification is handled with redis connections.
true

Control how peer verification is handled with redis connections. Peer verification is a security feature that checks if the host you're connecting to is who it says it is. This is often done by checking a digital certificate.

Type
Boolean
Default
true
Defined by
AuditRedisProperties

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.

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