JDBC Attribute Resolution
CAS does allow for attributes to be retrieved from a variety of SQL databases.
Support is enabled by including the following dependency 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
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-jdbc"
}
To learn how to configure database drivers, please see this guide.
The following settings and properties are available from the CAS configuration catalog:
cas.authn.attribute-repository.jdbc[0].driver-classThe JDBC driver used to connect to the database.
The JDBC driver used to connect to the database.
cas.authn.attribute-repository.jdbc[0].passwordThe database connection password.
The database connection password.
cas.authn.attribute-repository.jdbc[0].urlThe database connection URL.
The database connection URL.
cas.authn.attribute-repository.jdbc[0].userThe database user.
The database user.
The database user must have sufficient permissions to be able to handle schema changes and updates, when needed.
cas.authn.attribute-repository.jdbcRetrieve attributes from multiple JDBC repositories.
Retrieve attributes from multiple JDBC repositories.
cas.authn.attribute-repository.jdbc[0].attributesMap of attributes to fetch from the database.
Map of attributes to fetch from the database. Attributes are defined using a key-value structure where CAS allows the attribute name/key to be renamed virtually to a different attribute. The key is the attribute fetched from the data source and the value is the attribute name CAS should use for virtual renames. Attributes may be allowed to be virtually renamed and remapped. The key in the attribute map is the original attribute, and the value should be the virtually-renamed attribute.
cas.authn.attribute-repository.jdbc[0].autocommitThe default auto-commit behavior of connections in the pool.
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.attribute-repository.jdbc[0].batch-sizeA non-zero value enables use of JDBC2 batch updates by Hibernate. e.g. recommended values between 5 and 30.
A non-zero value enables use of JDBC2 batch updates by Hibernate. e.g. recommended values between 5 and 30.
cas.authn.attribute-repository.jdbc[0].case-canonicalizationWhen constructing the final person object from the attribute repository, indicate how the username should be canonicalized.
NONE-
UPPER: Transform the final person id into uppercase characters. -
LOWER: Transform the final person id into lowercase characters. -
NONE: Do nothing.
cas.authn.attribute-repository.jdbc[0].case-insensitive-query-attributesCollection of attributes, used to build the SQL query, that should go through a case canonicalization process defined as key->value .
Collection of attributes, used to build the SQL query, that should go through a case canonicalization process defined as key->value. Note that the key is not the name of the attribute, but the query attribute that is used in generating the final query clause (i.e. username). The value can be NONE, LOWER, UPPER.
It's also possible to define a list of attributes without a case canonicalization override such as username, attribute2 in which case #caseCanonicalization will dictate the final outcome.
cas.authn.attribute-repository.jdbc[0].column-mappingsUsed only when there is a mapping of many rows to one user.
----------------------------- uid | attr_name | attr_value ----------------------------- tom | first_name | ThomasThen a column mapping must be specified to teach CAS to use
attr_name and attr_value for attribute names and values.cas.authn.attribute-repository.jdbc[0].connection-timeoutIndicates the maximum number of milliseconds that the service can wait to obtain a connection.
Indicates the maximum number of milliseconds that the service can wait to obtain a connection.
cas.authn.attribute-repository.jdbc[0].data-source-nameAttempts to do a JNDI data source look up for the data source name specified.
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.attribute-repository.jdbc[0].ddl-autoHibernate feature to automatically validate and exports DDL to the schema.
validate or none may be more desirable for production, but any of the following options can be used: -
validate: Validate the schema, but make no changes to the database. -
update: Update the schema. -
create: Create the schema, destroying previous data. -
create-drop: Drop the schema at the end of the session. -
none: Do nothing.
Note that during a version migration where any schema has changed 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.attribute-repository.jdbc[0].default-catalogQualifies unqualified table names with the given catalog in generated SQL.
Qualifies unqualified table names with the given catalog in generated SQL.
cas.authn.attribute-repository.jdbc[0].default-schemaQualify unqualified table names with the given schema/tablespace in generated SQL.
Qualify unqualified table names with the given schema/tablespace in generated SQL.
cas.authn.attribute-repository.jdbc[0].dialectThe 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.
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.attribute-repository.jdbc[0].fail-fast-timeoutSet the pool initialization failure timeout.
- Any value greater than zero will be treated as a timeout for pool initialization. The calling thread will be blocked from continuing until a successful connection to the database, or until the timeout is reached. If the timeout is reached, then a
PoolInitializationExceptionwill be thrown. - A value of zero will not prevent the pool from starting in the case that a connection cannot be obtained. However, upon start the pool will attempt to obtain a connection and validate that the
connectionTestQueryandconnectionInitSqlare valid. If those validations fail, an exception will be thrown. If a connection cannot be obtained, the validation is skipped and the pool will start and continue to try to obtain connections in the background. This can mean that callers toDataSource#getConnection()may encounter exceptions. - A value less than zero will not bypass any connection attempt and validation during startup, and therefore the pool will start immediately. The pool will continue to try to obtain connections in the background. This can mean that callers to
DataSource#getConnection()may encounter exceptions.
connectionTimeout or validationTimeout; they will be honored before this timeout is applied. The default value is one millisecond.cas.authn.attribute-repository.jdbc[0].fetch-sizeUsed to specify number of rows to be fetched in a select query.
Used to specify number of rows to be fetched in a select query.
cas.authn.attribute-repository.jdbc[0].generate-statisticsAllow hibernate to generate query statistics.
Allow hibernate to generate query statistics.
cas.authn.attribute-repository.jdbc[0].health-queryThe SQL query to be executed to test the validity of connections.
The SQL query to be executed to test the validity of connections. This is for "legacy" databases that do not support the JDBC4 Connection.isValid() API.
cas.authn.attribute-repository.jdbc[0].idA value can be assigned to this field to uniquely identify this resolver.
A value can be assigned to this field to uniquely identify this resolver.
cas.authn.attribute-repository.jdbc[0].idle-timeoutControls the maximum amount of time that a connection is allowed to sit idle in the pool.
Controls the maximum amount of time that a connection is allowed to sit idle in the pool.
cas.authn.attribute-repository.jdbc[0].isolate-internal-queriesThis property determines whether data source isolates internal pool queries, such as the connection alive test, in their own transaction.
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.attribute-repository.jdbc[0].isolation-level-nameDefines the isolation level for transactions.
Defines the isolation level for transactions.
cas.authn.attribute-repository.jdbc[0].leak-thresholdControls the amount of time that a connection can be out of the pool before a message is logged indicating a possible connection leak.
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.attribute-repository.jdbc[0].orderThe order of this attribute repository in the chain of repositories.
The order of this attribute repository in the chain of repositories. Can be used to explicitly position this source in chain and affects merging strategies.
cas.authn.attribute-repository.jdbc[0].physical-naming-strategy-class-nameFully-qualified name of the class that can control the physical naming strategy of hibernate.
Fully-qualified name of the class that can control the physical naming strategy of hibernate.
cas.authn.attribute-repository.jdbc[0].pool.keep-alive-timeThis property controls the keepalive interval for a connection in the pool.
0This 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.
cas.authn.attribute-repository.jdbc[0].pool.max-sizeControls the maximum number of connections to keep in the pool, including both idle and in-use connections.
18Controls the maximum number of connections to keep in the pool, including both idle and in-use connections.
cas.authn.attribute-repository.jdbc[0].pool.max-waitSets the maximum time in seconds that this data source will wait while attempting to connect to a database.
PT2SSets 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.
cas.authn.attribute-repository.jdbc[0].pool.maximum-lifetimeThis property controls the maximum lifetime of a connection in the pool.
PT10MThis 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.
cas.authn.attribute-repository.jdbc[0].pool.min-sizeControls the minimum size that the pool is allowed to reach, including both idle and in-use connections.
6Controls the minimum size that the pool is allowed to reach, including both idle and in-use connections.
cas.authn.attribute-repository.jdbc[0].pool.nameSet the name of the connection pool.
Set the name of the connection pool. This is primarily used for the MBean to uniquely identify the pool configuration.
cas.authn.attribute-repository.jdbc[0].pool.suspensionWhether or not pool suspension is allowed.
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.attribute-repository.jdbc[0].pool.timeout-millisThe maximum number of milliseconds that the pool will wait for a connection to be validated as alive.
1000The maximum number of milliseconds that the pool will wait for a connection to be validated as alive.
cas.authn.attribute-repository.jdbc[0].propagation-behavior-nameDefines the propagation behavior for transactions.
Defines the propagation behavior for transactions.
cas.authn.attribute-repository.jdbc[0].propertiesAdditional settings provided by Hibernate (or the connection provider) in form of key-value pairs.
Additional settings provided by Hibernate (or the connection provider) in form of key-value pairs.
cas.authn.attribute-repository.jdbc[0].query-attributesDefine a Map of query attribute names to data-layer attribute names to use when building the query.
Define a Map of query attribute names to data-layer attribute names to use when building the query. The key is always the name of the query attribute that is defined by CAS and passed internally, and the value is the database column that should map.
cas.authn.attribute-repository.jdbc[0].query-typeIndicates how multiple attributes in a query should be concatenated together.
AND-
AND: Concatenate attributes in the query using an AND-clause. -
OR: Concatenate attributes in the query using an OR-clause.
cas.authn.attribute-repository.jdbc[0].read-onlyConfigures the Connections to be added to the pool as read-only Connections.
Configures the Connections to be added to the pool as read-only Connections.
cas.authn.attribute-repository.jdbc[0].require-all-attributesIf the SQL should only be run if all attributes listed in the mappings exist in the query.
trueIf the SQL should only be run if all attributes listed in the mappings exist in the query.
cas.authn.attribute-repository.jdbc[0].single-rowDesigned to work against a table where there is a mapping of one row to one user.
trueDesigned to work against a table where there is a mapping of one row to one user. The fields in the table structure is assumed to match username|name|lastname|address where there is only a single row per user. Setting this setting to false will force CAS to work against a table where there is a mapping of one row to one user. The fields in the table structure is assumed to match username|attr_name|attr_value where there is more than one row per username.
cas.authn.attribute-repository.jdbc[0].sqlThe SQL statement to execute and fetch attributes.
The SQL statement to execute and fetch attributes. The syntax of the query must be SELECT * FROM table WHERE {0}. The WHERE clause is dynamically generated by CAS.
cas.authn.attribute-repository.jdbc[0].stateWhether attribute resolution based on this source is enabled.
ACTIVE-
ACTIVE: Active and enabled repository, and is invoked by default automatically. -
DISABLED: Attribute repository is disabled and will not be used to resolve people and attributes. -
STANDBY: Repository is in a semi-enabled state, waiting to be called only on-demand when explicitly asked for and will not be registered into the resolution plan.
cas.authn.attribute-repository.jdbc[0].usernameUsername attribute(s) to use when running the SQL query.
Username attribute(s) to use when running the SQL query.
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.
Hibernate & JDBC
Control global properties that are relevant to Hibernate, when CAS attempts to employ and utilize database resources, connections and queries.
cas.jdbc.gen-ddlWhether to generate DDL after the EntityManagerFactory has been initialized creating/updating all relevant tables.
trueWhether to generate DDL after the EntityManagerFactory has been initialized creating/updating all relevant tables.
cas.jdbc.physical-table-namesIndicate 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.
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.
cas.jdbc.show-sqlWhether SQL queries should be displayed in the console/logs.
falseWhether SQL queries should be displayed in the console/logs.
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.
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.
JDBC attribute sources can be defined based on the following mechanics.
Single Row
Designed to work against a table where there is a mapping of one row to one user. An example of this table format would be:
| uid | first_name | last_name | |
|---|---|---|---|
jsmith |
John |
Smith |
jsmith@example.org |
Multi Row
Designed to work against a table where there is a mapping of one row to one user. An example of this table format would be:
| uid | attr_name | attr_value |
|---|---|---|
jsmith |
first_name |
John |
jsmith |
last_name |
Smith |
jsmith |
email |
jsmith@example.org |
You will need to define column mappings
in your configuration to map the attr_name column to the attr_value column
Examples
Suppose CAS is configured to authenticate against Active Directory. The account whose details are defined below
authenticates via sAMAccountName.
| Attribute | Value |
|---|---|
sAMAccountName |
johnsmith |
cn |
John Smith |
Example #1
If the resolver is configured to use sAMAccountName as the attribute for the principal id, then when authentication is complete the resolver attempts
to construct attributes from attribute repository sources, it sees sAMAccountName as the attribute and sees the principal id is to
be created by sAMAccountName. So it would remove the sAMAccountName from the attributes.
The final result is a principal whose id is johnsmith who has a cn attribute of John Smith.
Example #2
If the resolver is configured to use cn as the attribute for the principal id, then when authentication is complete the resolver attempts to
construct attributes from attribute repository sources. It then sees sAMAccountName as the attribute and sees the principal id is to be created by cn.
So it would remove the cn from the attributes. The final result is a principal whose id is John Smith
who has a sAMAccountName attribute of johnsmith.
Multitenancy
Configuration settings for SQL attribute resolution can be specified in a multitenant environment. Please review this guide for more information.