Audits

CAS uses the Inspektr framework for auditing purposes and statistics. The Inspektr project allows for non-intrusive auditing and logging of the coarse-grained execution paths e.g. Spring-managed beans method executions by using annotations and Spring-managed @Aspect-style aspects.

CAS server auto-configures all the relevant Inspektr components. All the available configuration options that are injected to Inspektr classes are available to deployers via relevant CAS properties. Note that the audit record management functionality of CAS supports handling multiple audit record destinations at the same time. In other words, you may choose to route audit records to both a database and a REST endpoint as well as any number of logger-based destinations all at the same time.

The following settings and properties are available from the CAS configuration catalog:

_{The configuration settings listed below are tagged as Required in the CAS configuration metadata. This flag indicates that the presence of the setting may be needed to activate or affect the behavior of the CAS feature and generally should be reviewed, possibly owned and adjusted. If the setting is assigned a default value, you do not need to strictly put the setting in your copy of the configuration, but should review it nonetheless to make sure it matches your deployment expectations.}

_{The configuration settings listed below are tagged as Optional in the CAS configuration metadata. This
flag indicates that the presence of the setting
is not immediately necessary in the end-user CAS configuration, because a default value is assigned or
the activation of the feature is not conditionally controlled by the setting value. You should only include this field in your
configuration if you need to modify the default value.}

cas.audit.engine.abbreviation-length=125

Abbreviate fields and entries in the audit logs where possible by the given length. This typically is applied to long service URLs that are captured in audit logs. Negative/Zero values disable the abbreviation altogether.

org.apereo.cas.configuration.model.core.audit.AuditEngineProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: 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.

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.audit.engine.abbreviation-length=125

This is the most common form of property configuration that is recognized by CAS, regardless of the actual property source, which might in fact be managed separately outside the CAS environment, by another system or cloud framework.

CAS properties can be specified using the YAML syntax:

cas: 
  audit: 
    engine: 
      abbreviation-length: 

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.audit.engine.abbreviation-length="125" -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory. Note the placement of the system property which must be specified before the CAS web application is launched.

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUDIT_ENGINE_ABBREVIATION_LENGTH="125"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.audit.engine.abbreviation-length="125"

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.audit.engine.alternate-client-addr-header-name=X-Forwarded-For

Request header to use to identify the client address.

If the application is sitting behind a load balancer, the client address typically ends up being the load balancer address itself. A common example for a header here would be X-Forwarded-For to glean the client address from the request, assuming the load balancer is configured correctly to pass that header along.

org.apereo.cas.configuration.model.core.audit.AuditEngineProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.audit.engine.alternate-client-addr-header-name=X-Forwarded-For

CAS properties can be specified using the YAML syntax:

cas: 
  audit: 
    engine: 
      alternate-client-addr-header-name: 

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.audit.engine.alternate-client-addr-header-name="X-Forwarded-For" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUDIT_ENGINE_ALTERNATE_CLIENT_ADDR_HEADER_NAME="X-Forwarded-For"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.audit.engine.alternate-client-addr-header-name="X-Forwarded-For"

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.audit.engine.alternate-server-addr-header-name=

Request header to use identify the server address.

org.apereo.cas.configuration.model.core.audit.AuditEngineProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.audit.engine.alternate-server-addr-header-name=...

CAS properties can be specified using the YAML syntax:

cas: 
  audit: 
    engine: 
      alternate-server-addr-header-name: 

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.audit.engine.alternate-server-addr-header-name="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUDIT_ENGINE_ALTERNATE_SERVER_ADDR_HEADER_NAME="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.audit.engine.alternate-server-addr-header-name="..."

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.audit.engine.app-code=CAS

Application code to use in the audit logs.

This is a unique code that acts as the identifier for the application. In case audit logs are aggregated in a central location. This makes it easy to identify the application and filter results based on the code.

org.apereo.cas.configuration.model.core.audit.AuditEngineProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.audit.engine.app-code=CAS

CAS properties can be specified using the YAML syntax:

cas: 
  audit: 
    engine: 
      app-code: 

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.audit.engine.app-code="CAS" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUDIT_ENGINE_APP_CODE="CAS"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.audit.engine.app-code="CAS"

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.audit.engine.audit-format=DEFAULT

The audit format to use in the logs. Available values are as follows:

DEFAULT: Default audit format.
JSON: Output audit logs as JSON strings where necessary/possible.

org.apereo.cas.configuration.model.core.audit.AuditEngineProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.audit.engine.audit-format=DEFAULT

CAS properties can be specified using the YAML syntax:

cas: 
  audit: 
    engine: 
      audit-format: 

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.audit.engine.audit-format="DEFAULT" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUDIT_ENGINE_AUDIT_FORMAT="DEFAULT"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.audit.engine.audit-format="DEFAULT"

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.audit.engine.enabled=true

Whether auditing functionality should be enabled.

org.apereo.cas.configuration.model.core.audit.AuditEngineProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.audit.engine.enabled=true

CAS properties can be specified using the YAML syntax:

cas: 
  audit: 
    engine: 
      enabled: 

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.audit.engine.enabled="true" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUDIT_ENGINE_ENABLED="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.audit.engine.enabled="true"

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.audit.engine.excluded-actions=

Indicate a list of supported audit actions that should be excluded, filtered and ignored by CAS audit managers. Each supported action can be treated as a regular expression to match against built-in CAS actions.

org.apereo.cas.configuration.model.core.audit.AuditEngineProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.audit.engine.excluded-actions=...

CAS properties can be specified using the YAML syntax:

cas: 
  audit: 
    engine: 
      excluded-actions: 

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.audit.engine.excluded-actions="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUDIT_ENGINE_EXCLUDED_ACTIONS="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.audit.engine.excluded-actions="..."

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.audit.engine.ignore-audit-failures=false

Indicates whether catastrophic audit failures should be logged or whether errors should bubble up and thrown back.

org.apereo.cas.configuration.model.core.audit.AuditEngineProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.audit.engine.ignore-audit-failures=...

CAS properties can be specified using the YAML syntax:

cas: 
  audit: 
    engine: 
      ignore-audit-failures: 

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.audit.engine.ignore-audit-failures="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUDIT_ENGINE_IGNORE_AUDIT_FAILURES="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.audit.engine.ignore-audit-failures="..."

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.audit.engine.include-validation-assertion=false

Whether ticket validation events in the audit log should include information about the assertion that is validated; things such as the principal id and attributes released.

org.apereo.cas.configuration.model.core.audit.AuditEngineProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.audit.engine.include-validation-assertion=...

CAS properties can be specified using the YAML syntax:

cas: 
  audit: 
    engine: 
      include-validation-assertion: 

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.audit.engine.include-validation-assertion="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUDIT_ENGINE_INCLUDE_VALIDATION_ASSERTION="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.audit.engine.include-validation-assertion="..."

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.audit.engine.number-of-days-in-history=30

Retrieve audit records from storage, starting from now and going back the indicated number of days in history.

org.apereo.cas.configuration.model.core.audit.AuditEngineProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.audit.engine.number-of-days-in-history=30

CAS properties can be specified using the YAML syntax:

cas: 
  audit: 
    engine: 
      number-of-days-in-history: 

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.audit.engine.number-of-days-in-history="30" -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUDIT_ENGINE_NUMBER_OF_DAYS_IN_HISTORY="30"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.audit.engine.number-of-days-in-history="30"

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.audit.engine.supported-actions=

Indicate a list of supported audit actions that should be recognized, processed and recorded by CAS audit managers. Each supported action can be treated as a regular expression to match against built-in CAS actions.

org.apereo.cas.configuration.model.core.audit.AuditEngineProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.audit.engine.supported-actions=...

CAS properties can be specified using the YAML syntax:

cas: 
  audit: 
    engine: 
      supported-actions: 

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.audit.engine.supported-actions="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUDIT_ENGINE_SUPPORTED_ACTIONS="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.audit.engine.supported-actions="..."

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

cas.audit.engine.use-server-host-address=false

Determines whether a local DNS lookup should be made to query for the CAS server address.

By default, the server is address is determined from the request. Aside from special headers, this option allows one to query DNS to look up the server address of the CAS server processing requests.

org.apereo.cas.configuration.model.core.audit.AuditEngineProperties.

_{How can I configure this property?}

Configuration properties can be included and activated using the following strategies.

:information_source: Note

CAS properties can be specified using the Java configuration property syntax in any and all .properties files:

cas.audit.engine.use-server-host-address=...

CAS properties can be specified using the YAML syntax:

cas: 
  audit: 
    engine: 
      use-server-host-address: 

Note that YAML is very specific about structure and indentation. Be sure to verify the correctness of the final result with your YAML validator of choice.

CAS properties can be passed to the CAS web application as system properties, when the application is launched:

java -Dcas.audit.engine.use-server-host-address="..." -jar build/libs/cas.war

CAS properties can specified as system environment variables before the CAS web application is launched:

export CAS_AUDIT_ENGINE_USE_SERVER_HOST_ADDRESS="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.

CAS properties can be passed to the CAS web application as command-line arguments, when the application is launched:

java -jar build/libs/cas.war --cas.audit.engine.use-server-host-address="..."

The above example assumes that the CAS web application is packaged as cas.war and can be found in the build/libs directory.