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 should be included automatically and are listed here 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-class=
The JDBC driver used to connect to the database.
|
cas.authn.attribute-repository.jdbc[0].password=
The database connection password.
|
cas.authn.attribute-repository.jdbc[0].url=
The database connection URL. This setting supports the Spring Expression Language.
|
cas.authn.attribute-repository.jdbc[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.attribute-repository.jdbc=
Retrieve attributes from multiple JDBC repositories.
|
cas.authn.attribute-repository.jdbc[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.attribute-repository.jdbc[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.attribute-repository.jdbc[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.attribute-repository.jdbc[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.attribute-repository.jdbc[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.attribute-repository.jdbc[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.attribute-repository.jdbc[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.attribute-repository.jdbc[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.attribute-repository.jdbc[0].attributes=
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].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.attribute-repository.jdbc[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.attribute-repository.jdbc[0].case-canonicalization=NONE
When constructing the final person object from the attribute repository, indicate how the username should be canonicalized. Accepted values are:
|
cas.authn.attribute-repository.jdbc[0].case-insensitive-query-attributes=
Collection of attributes, used to build the SQL query, that should go through
a case canonicalization process defined as username, attribute2
in which case #caseCanonicalization will dictate the final outcome.
|
cas.authn.attribute-repository.jdbc[0].column-mappings=
Used only when there is a mapping of many rows to one user. This is done using a key-value structure where the key is the name of the "attribute name" column the value is the name of the "attribute value" column. If the table structure is as such: ----------------------------- 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-timeout=
Indicates the maximum number of milliseconds that the service can wait to obtain a connection. This settings supports the
|
cas.authn.attribute-repository.jdbc[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.attribute-repository.jdbc[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.attribute-repository.jdbc[0].default-catalog=
Qualifies unqualified table names with the given catalog in generated SQL.
|
cas.authn.attribute-repository.jdbc[0].default-schema=
Qualify unqualified table names with the given schema/tablespace in generated SQL.
|
cas.authn.attribute-repository.jdbc[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.attribute-repository.jdbc[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.attribute-repository.jdbc[0].fetch-size=
Used to specify number of rows to be fetched in a select query.
|
cas.authn.attribute-repository.jdbc[0].generate-statistics=
Allow hibernate to generate query statistics.
|
cas.authn.attribute-repository.jdbc[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.attribute-repository.jdbc[0].id=
A value can be assigned to this field to uniquely identify this resolver.
|
cas.authn.attribute-repository.jdbc[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.attribute-repository.jdbc[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.attribute-repository.jdbc[0].isolation-level-name=
Defines the isolation level for transactions.
|
cas.authn.attribute-repository.jdbc[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.attribute-repository.jdbc[0].order=
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-name=
Fully-qualified name of the class that can control the physical naming strategy of hibernate.
|
cas.authn.attribute-repository.jdbc[0].propagation-behavior-name=
Defines the propagation behavior for transactions.
|
cas.authn.attribute-repository.jdbc[0].properties=
Additional settings provided by Hibernate (or the connection provider) in form of key-value pairs.
|
cas.authn.attribute-repository.jdbc[0].query-attributes=
Define a
|
cas.authn.attribute-repository.jdbc[0].query-type=AND
Indicates how multiple attributes in a query should be concatenated together. Accepted values are: *
|
cas.authn.attribute-repository.jdbc[0].read-only=
Configures the Connections to be added to the pool as read-only Connections.
|
cas.authn.attribute-repository.jdbc[0].require-all-attributes=true
If the SQL should only be run if all attributes listed in the mappings exist in the query.
|
cas.authn.attribute-repository.jdbc[0].single-row=true
Designed 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
|
cas.authn.attribute-repository.jdbc[0].sql=
The SQL statement to execute and fetch attributes.
The syntax of the query must be This setting supports the Spring Expression Language.
|
cas.authn.attribute-repository.jdbc[0].state=ACTIVE
Whether attribute resolution based on this source is enabled. Available values are as follows:
|
cas.authn.attribute-repository.jdbc[0].username=
Username attribute(s) to use when running the SQL query.
|
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
|
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, 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.
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 sAMAccoutName
as the attribute for the principal id, then when authentication is complete the resolver attempts
to construct attributes from attribute repository sources, it sees sAMAccoutName
as the attribute and sees the principal id is to
be created by sAMAccoutName
. So it would remove the sAMAccoutName
from the attributes.
The final result is 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 sAMAccoutName
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 is a principal whose id is John Smith
who has a sAMAccountName
attribute of johnsmith
.