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.

  • cas.audit.engine.alternate-client-addr-header-name=
  • Request header to use 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.

  • cas.audit.engine.alternate-server-addr-header-name=
  • Request header to use identify the server address.

  • 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.

  • cas.audit.engine.audit-format=
  • 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.

  • cas.audit.engine.enabled=true
  • Whether auditing functionality should be enabled.

  • 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.

  • cas.audit.engine.ignore-audit-failures=false
  • Indicates whether catastrophic audit failures should be logged or whether errors should bubble up and thrown back.

  • 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.

  • 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.

  • 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.

  • 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.

    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 below 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.S ettings 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. The validation process is on by default and can be skipped on startup using a special system property SKIP_CONFIG_VALIDATION that should be set to true. 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.

    Administrative Endpoints

    The following endpoints are provided by CAS:

    Endpoint Description
    auditLog Provides a JSON representation of all the audit log.

    You can specify an interval of log entries to return by adding a Duration Syntax to the navigated path. This interval will be subtracted from the current date and time when the query is executed. For instance /actuator/auditLog/PT1H will return only entries for the past hour.

    The actuator endpoint can also accept a JSON object through a POST method containing criteria to filter log entries by.

    The following filters that can be applied:

    Key Value
    interval PT1H, PT10M, P1D
    actionPerformed TICKET_GRANTING_TICKET_CREATED, SERVICE_TICK.*
    clientIpAddress 111.111.111.111, 111.111.*
    username casuser, cas.*
    resourceOperatedOn ST-1.*, TGT-1-.*

    Each filter other than interval can accept a regular expression to match against.

    File-based Audits

    Please see this guide for more info.

    Database Audits

    Please see this guide for more info.

    MongoDb Audits

    Please see this guide for more info.

    Redis Audits

    Please see this guide for more info.

    CouchDb Audits

    Please see this guide for more info.

    Couchbase Audits

    Please see this guide for more info.

    DynamoDb Audits

    Please see this guide for more info.

    REST Audits

    Please see this guide for more info.

    Audit Events

    The following events are tracked and recorded in the audit log:

    Event Action
    TICKET_GRANTING_TICKET CREATED, NOT_CREATED, DESTROYED
    PROXY_GRANTING_TICKET CREATED, NOT_CREATED, DESTROYED
    SERVICE_TICKET CREATED, NOT_CREATED
    PROXY_TICKET CREATED, NOT_CREATED
    AUTHENTICATION SUCCESS, FAILED
    AUTHENTICATION_EVENT TRIGGERED
    AUP_VERIFY TRIGGERED
    AUP_SUBMIT TRIGGERED
    EVALUATE_RISKY_AUTHENTICATION N/A
    MITIGATE_RISKY_AUTHENTICATION N/A
    MULTIFACTOR_AUTHENTICATION_BYPASS N/A
    SAVE_SERVICE SUCCESS, FAILURE
    SAVE_CONSENT SUCCESS, FAILURE
    REQUEST_CHANGE_PASSWORD N/A
    CHANGE_PASSWORD SUCCESS, FAILURE
    DELETE_SERVICE SUCCESS, FAILURE
    SAML2_RESPONSE CREATED, FAILED
    SAML2_REQUEST CREATED, FAILED
    OAUTH2_USER_PROFILE CREATED, FAILED
    OAUTH2_ACCESS_TOKEN_REQUEST CREATED, FAILED
    OAUTH2_ACCESS_TOKEN_RESPONSE CREATED, FAILED
    OAUTH2_CODE_RESPONSE CREATED, FAILED
    REST_API_TICKET_GRANTING_TICKET CREATED, FAILED
    REST_API_SERVICE_TICKET CREATED, FAILED
    SERVICE_ACCESS_ENFORCEMENT TRIGGERED
    DELEGATED_CLIENT SUCCESS, FAILURE
    SURROGATE_AUTHENTICATION_ELIGIBILITY_VERIFICATION TRIGGERED
    SURROGATE_AUTHENTICATION_ELIGIBILITY_SELECTION TRIGGERED