WORKERS AHEAD!
You are viewing the development documentation for the Apereo CAS server. The functionality presented here is not officially released yet. This is a work in progress and will be continually updated as development moves forward. You are most encouraged to test the changes presented.
Search Database Authentication
Searches for a user record by querying against a username and password; the user is authenticated if at least one result is found.
The following settings and properties are available from the CAS configuration catalog:
cas.authn.jdbc.search[0].password-encoder.encoding-algorithm=
The encoding algorithm to use such as
|
cas.authn.jdbc.search[0].password-encoder.type=NONE
Define the password encoder type to use.
Type may be specified as blank or
|
cas.authn.jdbc.search[0].principal-transformation.groovy.location=
Transform usernames using a Groovy resource. 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.
In situations and scenarios where CAS is able to automatically watch the underlying resource
for changes and detect updates and modifications dynamically, you may be able to specify the following
setting as either an environment variable or system property with a value of false to disable
the resource watcher: org.apereo.cas.util.io.PathWatcherService.
|
cas.authn.jdbc.search[0].driver-class=
The JDBC driver used to connect to the database.
|
cas.authn.jdbc.search[0].field-password=
Password column name.
|
cas.authn.jdbc.search[0].field-user=
Username column name.
|
cas.authn.jdbc.search[0].password=
The database connection password.
|
cas.authn.jdbc.search[0].table-users=
Table name where accounts are held.
|
cas.authn.jdbc.search[0].url=
The database connection URL. This setting supports the Spring Expression Language.
|
cas.authn.jdbc.search[0].user=
The database user. The database user must have sufficient permissions to be able to handle schema changes and updates, when needed.
|
cas.authn.jdbc.search[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.search[0].password-encoder.hash-length=16
When used by
|
cas.authn.jdbc.search[0].password-encoder.iterations=310000
When used by
|
cas.authn.jdbc.search[0].password-encoder.secret=
Secret to use with
|
cas.authn.jdbc.search[0].password-encoder.strength=16
Strength or number of iterations to use for password hashing.
Usually relevant when dealing with
|
cas.authn.jdbc.search[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. This setting supports the Spring Expression Language.
|
cas.authn.jdbc.search[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.search[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. This setting supports the Spring Expression Language.
|
cas.authn.jdbc.search[0].principal-transformation.prefix=
Prefix to add to the principal id prior to authentication. This setting supports the Spring Expression Language.
|
cas.authn.jdbc.search[0].principal-transformation.suffix=
Suffix to add to the principal id prior to authentication. This setting supports the Spring Expression Language.
|
cas.authn.jdbc.search[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.search[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.search[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.search[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.search[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.search[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.search[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.search[0].pool.timeout-millis=1000
The maximum number of milliseconds that the pool will wait for a connection to be validated as alive.
|
cas.authn.jdbc.search=
Settings related to search-mode jdbc authentication. Searches for a user record by querying against a username and password; the user is authenticated if at least one result is found.
|
cas.authn.jdbc.search[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.search[0].batch-size=
A non-zero value enables use of JDBC2 batch updates by Hibernate. e.g. recommended values between 5 and 30.
|
cas.authn.jdbc.search[0].connection-timeout=
Indicates the maximum number of milliseconds that the service can wait to obtain a connection. This settings supports the
|
cas.authn.jdbc.search[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:
This settings supports regular expression patterns. [?].
|
cas.authn.jdbc.search[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.search[0].ddl-auto=
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.search[0].default-catalog=
Qualifies unqualified table names with the given catalog in generated SQL.
|
cas.authn.jdbc.search[0].default-schema=
Qualify unqualified table names with the given schema/tablespace in generated SQL.
|
cas.authn.jdbc.search[0].dialect=
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.search[0].fail-fast-timeout=
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.search[0].fetch-size=
Used to specify number of rows to be fetched in a select query.
|
cas.authn.jdbc.search[0].generate-statistics=
Allow hibernate to generate query statistics.
|
cas.authn.jdbc.search[0].health-query=
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.search[0].idle-timeout=
Controls the maximum amount of time that a connection is allowed to sit idle in the pool. This settings supports the
|
cas.authn.jdbc.search[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.search[0].isolation-level-name=
Defines the isolation level for transactions.
|
cas.authn.jdbc.search[0].leak-threshold=
Controls the amount of time that a connection can be out of the pool before a message is logged indicating a possible connection leak. This settings supports the
|
cas.authn.jdbc.search[0].name=
Name of the authentication handler.
|
cas.authn.jdbc.search[0].order=
Order of the authentication handler in the chain.
|
cas.authn.jdbc.search[0].physical-naming-strategy-class-name=
Fully-qualified name of the class that can control the physical naming strategy of hibernate.
|
cas.authn.jdbc.search[0].principal-attribute-list=
List of column names to fetch as user attributes. This is only effective in scenarios where the JDBC authentication method is able to execute a SQL query against a database table and return results. Authentication methods that merely check for the user account's existence or verify the user with just a simple bind are not able to fetch attributes. Attributes name are separated by a comma and may use a "directed list" syntax where the allowed syntax would becolumn-name->cas-attribute.
|
cas.authn.jdbc.search[0].propagation-behavior-name=
Defines the propagation behavior for transactions.
|
cas.authn.jdbc.search[0].properties=
Additional settings provided by Hibernate (or the connection provider) in form of key-value pairs.
|
cas.authn.jdbc.search[0].read-only=
Configures the Connections to be added to the pool as read-only Connections.
|
cas.authn.jdbc.search[0].state=
Define the scope and state of this authentication handler and the lifecycle in which it can be invoked or activated. Available values are as follows:
|
Control global properties that are relevant to Hibernate, when CAS attempts to employ and utilize database resources, connections and queries.
cas.jdbc.case-insensitive=false
When choosing physical table names, determine whether names should be considered case-insensitive. How can I configure this property?
|
cas.jdbc.gen-ddl=true
Whether to generate DDL after the EntityManagerFactory has been initialized creating/updating all relevant tables. How can I configure this property?
|
cas.jdbc.physical-table-names=
Indicate a physical table name to be used by the hibernate naming strategy in case table names need to be customized for the specific type of database. The key here indicates the CAS-provided table name and the value is the translate physical name for the database. If a match is not found for the CAS-provided table name, then that name will be used by default. How can I configure this property?
|
cas.jdbc.show-sql=false
|
Please review this guide to configure your build.
cas.authn.jdbc.search[0].password-encoder.encoding-algorithm=
The encoding algorithm to use such as
|
cas.authn.jdbc.search[0].password-encoder.type=NONE
Define the password encoder type to use.
Type may be specified as blank or
|
cas.authn.jdbc.search[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.search[0].password-encoder.hash-length=16
When used by
|
cas.authn.jdbc.search[0].password-encoder.iterations=310000
When used by
|
cas.authn.jdbc.search[0].password-encoder.secret=
Secret to use with
|
cas.authn.jdbc.search[0].password-encoder.strength=16
Strength or number of iterations to use for password hashing.
Usually relevant when dealing with
|
If you need to design your own password encoding scheme where the type is specified as a fully qualified Java class name, the structure of the class would be similar to the following:
1
2
3
4
5
6
7
8
9
10
11
package org.example.cas;
import org.springframework.security.crypto.codec.*;
import org.springframework.security.crypto.password.*;
public class MyEncoder extends AbstractPasswordEncoder {
@Override
protected byte[] encode(CharSequence rawPassword, byte[] salt) {
return ...
}
}
If you need to design your own password encoding scheme where the type is specified as a path to a Groovy script, the structure of the script would be similar to the following:
1
2
3
4
5
6
7
8
9
10
11
12
import java.util.*
byte[] run(final Object... args) {
def (rawPassword,generatedSalt,logger,applicationContext) = args
logger.debug("Encoding password...")
return ...
}
Boolean matches(final Object... args) {
def (rawPassword,encodedPassword,logger,applicationContext) = args
logger.debug("Does match or not ?");
return ...
To prepare CAS to support and integrate with Apache Groovy, please review this guide.
cas.authn.jdbc.search[0].principal-transformation.groovy.location=
Transform usernames using a Groovy resource. 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.
In situations and scenarios where CAS is able to automatically watch the underlying resource
for changes and detect updates and modifications dynamically, you may be able to specify the following
setting as either an environment variable or system property with a value of false to disable
the resource watcher: org.apereo.cas.util.io.PathWatcherService.
|
cas.authn.jdbc.search[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. This setting supports the Spring Expression Language.
|
cas.authn.jdbc.search[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.search[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. This setting supports the Spring Expression Language.
|
cas.authn.jdbc.search[0].principal-transformation.prefix=
Prefix to add to the principal id prior to authentication. This setting supports the Spring Expression Language.
|
cas.authn.jdbc.search[0].principal-transformation.suffix=
Suffix to add to the principal id prior to authentication. This setting supports the Spring Expression Language.
|
Authentication handlers that generally deal with username-password credentials can be configured to transform the user id prior to executing the authentication sequence. Each authentication strategy in CAS provides settings to properly transform the principal. Refer to the relevant settings for the authentication strategy at hand to learn more.
Authentication handlers as part of principal transformation may also be provided a path to a Groovy script to transform the provided username. The outline of the script may take on the following form:
1
2
3
4
String run(final Object... args) {
def (providedUsername,logger) = args
return providedUsername.concat("SomethingElse")
}
To prepare CAS to support and integrate with Apache Groovy, please review this guide.
Certain 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:
- A regular expression pattern that is tested against the credential identifier.
- A fully qualified class name of your own design that looks similar to the below example:
1
2
3
4
5
6
7
8
9
import java.util.function.Predicate;
import org.apereo.cas.authentication.Credential;
public class PredicateExample implements Predicate<Credential> {
@Override
public boolean test(final Credential credential) {
// Examine the credential and return true/false
}
}
- Path to an external Groovy script that looks similar to the below example:
1
2
3
4
5
6
7
8
9
import org.apereo.cas.authentication.Credential
import java.util.function.Predicate
class PredicateExample implements Predicate<Credential> {
@Override
boolean test(final Credential credential) {
// test and return result
}
}
To prepare CAS to support and integrate with Apache Groovy, please review this guide.
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, specially 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.