Database Audits
If you intend to use a database for auditing functionality, enable the following module in your configuration:
1
2
3
4
5
<dependency>
<groupId>org.apereo.cas</groupId>
<artifactId>cas-server-support-audit-jdbc</artifactId>
<version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-support-audit-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-audit-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-audit-jdbc"
}
To learn how to configure database drivers, please review this guide.
The following settings and properties are available from the CAS configuration catalog:
cas.audit.jdbc.driver-classThe JDBC driver used to connect to the database.
org.hsqldb.jdbcDriverThe JDBC driver used to connect to the database.
cas.audit.jdbc.passwordThe database connection password.
The database connection password.
cas.audit.jdbc.urlThe database connection URL.
jdbc:hsqldb:mem:cas-hsql-databaseThe database connection URL.
cas.audit.jdbc.userThe database user.
saThe database user.
The database user must have sufficient permissions to be able to handle schema changes and updates, when needed.
cas.audit.jdbc.asynchronousExecute the recording of audit records in async manner.
trueExecute the recording of audit records in async manner. This setting must almost always be set to true.
cas.audit.jdbc.autocommitThe default auto-commit behavior of connections in the pool.
falseThe 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.audit.jdbc.batch-sizeA non-zero value enables use of JDBC2 batch updates by Hibernate. e.g. recommended values between 5 and 30.
100A non-zero value enables use of JDBC2 batch updates by Hibernate. e.g. recommended values between 5 and 30.
cas.audit.jdbc.column-lengthAllows one to trim the audit data by the specified length.
512Allows one to trim the audit data by the specified length. A negative value disables the trimming process where the audit functionality no longer substrings the audit record.
cas.audit.jdbc.connection-timeoutIndicates the maximum number of milliseconds that the service can wait to obtain a connection.
PT30SIndicates the maximum number of milliseconds that the service can wait to obtain a connection.
cas.audit.jdbc.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.audit.jdbc.date-formatter-functionA formatter function that receives the formatted date value and the date pattern as the first and second argument.
A formatter function that receives the formatted date value and the date pattern as the first and second argument. Example: TO_DATE('%s', '%s').
cas.audit.jdbc.date-formatter-patternIndicate the date formatter pattern used to fetch audit records from the database based on the record date.
Indicate the date formatter pattern used to fetch audit records from the database based on the record date. Default value is yyyy-MM-dd 00:00:00.000000.
cas.audit.jdbc.ddl-autoHibernate feature to automatically validate and exports DDL to the schema.
updatevalidate 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.audit.jdbc.default-catalogQualifies unqualified table names with the given catalog in generated SQL.
Qualifies unqualified table names with the given catalog in generated SQL.
cas.audit.jdbc.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.audit.jdbc.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.
org.hibernate.dialect.HSQLDialectThe 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.audit.jdbc.fail-fast-timeoutSet the pool initialization failure timeout.
1- 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.audit.jdbc.fetch-sizeUsed to specify number of rows to be fetched in a select query.
100Used to specify number of rows to be fetched in a select query.
cas.audit.jdbc.generate-statisticsAllow hibernate to generate query statistics.
falseAllow hibernate to generate query statistics.
cas.audit.jdbc.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.audit.jdbc.idle-timeoutControls the maximum amount of time that a connection is allowed to sit idle in the pool.
PT10MControls the maximum amount of time that a connection is allowed to sit idle in the pool.
cas.audit.jdbc.isolate-internal-queriesThis property determines whether data source isolates internal pool queries, such as the connection alive test, in their own transaction.
falseThis 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.audit.jdbc.isolation-level-nameDefines the isolation level for transactions.
ISOLATION_READ_COMMITTEDDefines the isolation level for transactions. @see org.springframework.transaction.TransactionDefinition
cas.audit.jdbc.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.
PT6SControls the amount of time that a connection can be out of the pool before a message is logged indicating a possible connection leak.
cas.audit.jdbc.max-age-daysIndicates how long audit records should be kept in the database.
180Indicates how long audit records should be kept in the database. This is used by the clean-up criteria to clean up after stale audit records.
cas.audit.jdbc.physical-naming-strategy-class-nameFully-qualified name of the class that can control the physical naming strategy of hibernate.
org.apereo.cas.hibernate.CasHibernatePhysicalNamingStrategyFully-qualified name of the class that can control the physical naming strategy of hibernate.
cas.audit.jdbc.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.audit.jdbc.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.audit.jdbc.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.audit.jdbc.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.audit.jdbc.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.audit.jdbc.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.audit.jdbc.pool.suspensionWhether or not pool suspension is allowed.
falseWhether 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.audit.jdbc.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.audit.jdbc.propagation-behavior-nameDefines the propagation behavior for transactions.
PROPAGATION_REQUIREDDefines the propagation behavior for transactions. @see org.springframework.transaction.TransactionDefinition
cas.audit.jdbc.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.audit.jdbc.read-onlyConfigures the Connections to be added to the pool as read-only Connections.
falseConfigures the Connections to be added to the pool as read-only Connections.
cas.audit.jdbc.schedule.cron-expressionA cron-like expression, extending the usual UN*X definition to include triggers on the second, minute, hour, day of month, month, and day of week.
A cron-like expression, extending the usual UN*X definition to include triggers on the second, minute, hour, day of month, month, and day of week. For example, 0 * * * * MON-FRI means once per minute on weekdays (at the top of the minute - the 0th second) or 0 0 0 * * * means every day at midnight. * Note that when cron expressions are defined, the start delay and repeat interval settings are must be removed and set to blank.
cas.audit.jdbc.schedule.cron-time-zoneA time zone for which the cron expression will be resolved.
A time zone for which the cron expression will be resolved. By default, this attribute is empty (i.e. the scheduler's time zone will be used).
cas.audit.jdbc.schedule.enabledWhether scheduler should be enabled to schedule the job to run.
trueWhether scheduler should be enabled to schedule the job to run.
cas.audit.jdbc.schedule.enabled-on-hostOverrides SchedulingProperties#enabled property value of true if this property does not match hostname of CAS server.
.*Overrides SchedulingProperties#enabled property value of true if this property does not match hostname of CAS server. This can be useful if deploying CAS with an image in a statefulset where all names are predictable but where having different configurations for different servers is hard. The value can be an exact hostname or a regular expression that will be used to match the hostname.
cas.audit.jdbc.schedule.repeat-intervalString representation of a repeat interval of re-loading data for a data store implementation.
PT2MString representation of a repeat interval of re-loading data for a data store implementation. This is the timeout between consecutive job’s executions.
cas.audit.jdbc.schedule.start-delayString representation of a start delay of loading data for a data store implementation.
PT15SString representation of a start delay of loading data for a data store implementation. This is the delay between scheduler startup and first job’s execution
cas.audit.jdbc.select-sql-query-templateSQL query that provides a template to fetch audit records.
SQL query that provides a template to fetch audit records. Accepts two parameters using %s for table name and audit date.
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.
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.
Database Schema
The table schema roughly should match the following structure:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
CREATE TABLE COM_AUDIT_TRAIL
(
AUD_USER VARCHAR2(100) NOT NULL,
AUD_CLIENT_IP VARCHAR(15) NOT NULL,
AUD_SERVER_IP VARCHAR(15) NOT NULL,
AUD_RESOURCE VARCHAR2(1024) NOT NULL,
AUD_TENANT VARCHAR(25) NOT NULL,
AUD_ACTION VARCHAR2(100) NOT NULL,
APPLIC_CD VARCHAR2(5) NOT NULL,
AUD_DATE TIMESTAMP NOT NULL,
AUD_GEOLOCATION VARCHAR2(100) NOT NULL,
AUD_USERAGENT VARCHAR2(100) NOT NULL,
AUD_LOCALE VARCHAR2(10) NOT NULL,
AUD_HEADERS TEXT NOT NULL,
AUD_EXTRA_INFO TEXT NOT NULL
)