Database Authentication
Database authentication is enabled by including the following dependencies in the WAR overlay:
1
2
3
4
5
<dependency>
<groupId>org.apereo.cas</groupId>
<artifactId>cas-server-support-jdbc</artifactId>
<version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-support-jdbc:${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-jdbc"
}
1
2
3
4
5
6
dependencies {
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-jdbc"
}
To learn how to configure database drivers, please see this guide.
Configuration
Query Database Authentication
Authenticates a user by comparing the user password (which can be encoded with a password encoder) against the password on record determined by a configurable database query.
The following settings and properties are available from the CAS configuration catalog:
cas.authn.jdbc.query[0].password-encoder.encoding-algorithm=
The encoding algorithm to use such as |
cas.authn.jdbc.query[0].password-encoder.type=NONE
Define the password encoder type to use.
Type may be specified as blank or
|
cas.authn.jdbc.query[0].principal-transformation.groovy.location=
The location of the resource. Resources can be URLS, or files found either on the classpath or outside somewhere in the file system. In the event the configured resource is a Groovy script, specially if the script set to reload on changes, you may need to adjust the total number ofinotify instances.
On Linux, you may need to add the following line to /etc/sysctl.conf :
fs.inotify.max_user_instances = 256 .
You can check the current value via cat /proc/sys/fs/inotify/max_user_instances .
|
cas.authn.jdbc.query[0].driver-class=org.hsqldb.jdbcDriver
The JDBC driver used to connect to the database. |
cas.authn.jdbc.query[0].field-password=
Password field/column name to retrieve. |
cas.authn.jdbc.query[0].password=EMPTY
The database connection password. |
cas.authn.jdbc.query[0].sql=
SQL query to execute. Example: |
cas.authn.jdbc.query[0].url=jdbc:hsqldb:mem:cas-hsql-database
The database connection URL. This setting supports the Spring Expression Language. |
cas.authn.jdbc.query[0].user=sa
The database user. The database user must have sufficient permissions to be able to handle schema changes and updates, when needed. |
cas.authn.jdbc.query[0].password-encoder.character-encoding=UTF-8
The encoding algorithm to use such as 'UTF-8'.
Relevant when the type used is |
cas.authn.jdbc.query[0].password-encoder.hash-length=16
When used by |
cas.authn.jdbc.query[0].password-encoder.secret=
Secret to use with |
cas.authn.jdbc.query[0].password-encoder.strength=16
Strength or number of iterations to use for password hashing.
Usually relevant when dealing with |
cas.authn.jdbc.query[0].principal-transformation.blocking-pattern=
A regular expression that will be used against the username to match for blocking/forbidden values. If a match is found, an exception will be thrown and principal transformation will fail. |
cas.authn.jdbc.query[0].principal-transformation.case-conversion=NONE
Indicate whether the principal identifier should be transformed into upper-case, lower-case, etc. Available values are as follows:
|
cas.authn.jdbc.query[0].principal-transformation.pattern=
A regular expression that will be used against the provided username for username extractions. On a successful match, the first matched group in the pattern will be used as the extracted username. |
cas.authn.jdbc.query[0].principal-transformation.prefix=
Prefix to add to the principal id prior to authentication. |
cas.authn.jdbc.query[0].principal-transformation.suffix=
Suffix to add to the principal id prior to authentication. |
cas.authn.jdbc.query[0].pool.keep-alive-time=0
This property controls the keepalive interval for a connection in the pool. An in-use connection will never be tested by the keepalive thread, only when it is idle will it be tested. Default is zero, which disables this feature. This settings supports the
|
cas.authn.jdbc.query[0].pool.max-size=18
Controls the maximum number of connections to keep in the pool, including both idle and in-use connections. |
cas.authn.jdbc.query[0].pool.max-wait=PT2S
Sets the maximum time in seconds that this data source will wait while attempting to connect to a database. A value of zero specifies that the timeout is the default system timeout if there is one; otherwise, it specifies that there is no timeout. This settings supports the
|
cas.authn.jdbc.query[0].pool.maximum-lifetime=PT10M
This property controls the maximum lifetime of a connection in the pool. When a connection reaches this timeout, even if recently used, it will be retired from the pool. An in-use connection will never be retired, only when it is idle will it be removed. This settings supports the
|
cas.authn.jdbc.query[0].pool.min-size=6
Controls the minimum size that the pool is allowed to reach, including both idle and in-use connections. |
cas.authn.jdbc.query[0].pool.name=
Set the name of the connection pool. This is primarily used for the MBean to uniquely identify the pool configuration. |
cas.authn.jdbc.query[0].pool.suspension=
Whether or not pool suspension is allowed. There is a performance impact when pool suspension is enabled. Unless you need it (for a redundancy system for example) do not enable it. |
cas.authn.jdbc.query[0].pool.timeout-millis=1_000L
The maximum number of milliseconds that the pool will wait for a connection to be validated as alive. |
cas.authn.jdbc.query=
Settings related to query-mode jdbc authentication. Authenticates a user by comparing the user password (which can be encoded with a password encoder) against the password on record determined by a configurable database query. |
cas.authn.jdbc.query[0].autocommit=
The default auto-commit behavior of connections in the pool. Determined whether queries such as update/insert should be immediately executed without waiting for an underlying transaction. |
cas.authn.jdbc.query[0].batch-size=100
A non-zero value enables use of JDBC2 batch updates by Hibernate. e.g. recommended values between 5 and 30. |
cas.authn.jdbc.query[0].credential-criteria=
A number of authentication handlers are allowed to determine whether they can operate on the provided credential and as such lend themselves to be tried and tested during the authentication handler selection phase. The credential criteria may be one of the following options:
|
cas.authn.jdbc.query[0].data-source-name=
Attempts to do a JNDI data source look up for the data source name specified. Will attempt to locate the data source object as is. |
cas.authn.jdbc.query[0].ddl-auto=update
Hibernate feature to automatically validate and exports DDL to the schema.
By default, creates and drops the schema automatically when a session is starts and ends.
Setting the value to
create-drop will result
in the loss of all data as soon as CAS is started. For transient data like tickets this is probably
not an issue, but in cases like the audit table important data could be lost. Using `update`, while safe
for data, is confirmed to result in invalid database state. validate or none settings
are likely the only safe options for production use.
For more info, see this.
|
cas.authn.jdbc.query[0].default-catalog=
Qualifies unqualified table names with the given catalog in generated SQL. |
cas.authn.jdbc.query[0].default-schema=
Qualify unqualified table names with the given schema/tablespace in generated SQL. |
cas.authn.jdbc.query[0].dialect=org.hibernate.dialect.HSQLDialect
The database dialect is a configuration setting for platform independent software (JPA, Hibernate, etc) which allows such software to translate its generic SQL statements into vendor specific DDL, DML. |
cas.authn.jdbc.query[0].fail-fast-timeout=1
Set the pool initialization failure timeout.
connectionTimeout or validationTimeout ; they will be honored before this
timeout is applied. The default value is one millisecond.
|
cas.authn.jdbc.query[0].fetch-size=100
Used to specify number of rows to be fetched in a select query. |
cas.authn.jdbc.query[0].field-disabled=
Boolean field that should indicate whether the account is disabled. |
cas.authn.jdbc.query[0].field-expired=
Boolean field that should indicate whether the account is expired. |
cas.authn.jdbc.query[0].generate-statistics=
Allow hibernate to generate query statistics. |
cas.authn.jdbc.query[0].health-query=EMPTY
The SQL query to be executed to test the validity of connections.
This is for "legacy" databases that do not support the JDBC4 |
cas.authn.jdbc.query[0].idle-timeout=PT10M
Controls the maximum amount of time that a connection is allowed to sit idle in the pool. This settings supports the
|
cas.authn.jdbc.query[0].isolate-internal-queries=
This property determines whether data source isolates internal pool queries, such as the connection alive test, in their own transaction. Since these are typically read-only queries, it is rarely necessary to encapsulate them in their own transaction. This property only applies if#autocommit is disabled.
|
cas.authn.jdbc.query[0].isolation-level-name=ISOLATION_READ_COMMITTED
Defines the isolation level for transactions. |
cas.authn.jdbc.query[0].leak-threshold=3_000L
Controls the amount of time that a connection can be out of the pool before a message is logged indicating a possible connection leak. |
cas.authn.jdbc.query[0].name=
Name of the authentication handler. |
cas.authn.jdbc.query[0].order=MAX_VALUE
Order of the authentication handler in the chain. |
cas.authn.jdbc.query[0].physical-naming-strategy-class-name=org.apereo.cas.hibernate.CasHibernatePhysicalNamingStrategy
Fully-qualified name of the class that can control the physical naming strategy of hibernate. |
cas.authn.jdbc.query[0].principal-attribute-list=
List of column names to fetch as user attributes. |
cas.authn.jdbc.query[0].propagation-behavior-name=PROPAGATION_REQUIRED
Defines the propagation behavior for transactions. |
cas.authn.jdbc.query[0].properties=
Additional settings provided by Hibernate (or the connection provider) in form of key-value pairs. |
cas.authn.jdbc.query[0].read-only=
Configures the Connections to be added to the pool as read-only Connections. |
cas.authn.jdbc.query[0].state=ACTIVE
Define the scope and state of this authentication handler and the lifecycle in which it can be invoked or activated. |