Service Management

The CAS service management facility allows CAS server administrators to declare and configure which services (CAS clients) may make use of CAS in which ways. The core component of the service management facility is the service registry that stores one or more registered services containing metadata that drives a number of CAS behaviors:

  • Authorized services - Control which services may participate in a CAS SSO session.
  • Forced authentication - Provides administrative control for forced authentication.
  • Attribute release - Provide user details to services for authorization and personalization.
  • Proxy control - Further restrict authorized services by granting/denying proxy authentication capability.
  • Theme control - Define alternate CAS themes to be used for particular services.

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.service-registry.core.init-from-json=false
  • Flag that indicates whether to initialise active service registry implementation with a default set of service definitions included with CAS by default in JSON format. The initialization generally tends to find JSON service definitions from org.apereo.cas.configuration.model.support.services.json.JsonServiceRegistryProperties#getLocation().

    org.apereo.cas.configuration.model.core.services.ServiceRegistryCoreProperties.

  • cas.service-registry.core.management-type=DEFAULT
  • Determine how services are internally managed, queried, cached and reloaded by CAS. Accepted values are the following:

    • DEFAULT: Keep all services inside a concurrent map.
    • DOMAIN: Group registered services by their domain having been explicitly defined.
    Available values are as follows:
    • DOMAIN: Group service definitions by their domain.
    • DEFAULT: Default option to keep definitions in a map as they arrive.

    org.apereo.cas.configuration.model.core.services.ServiceRegistryCoreProperties.

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

    Caching Services

    CAS service definitions that are loaded from service registries are cached with a expire-after-write expiration policy. Such definition are automatically expired and removed from the cache, unless forcefully removed with an explicit reload operation. In particular, you want to make sure the cache expiration policy and period does not conflict with reload operations and schedules. For example, misconfiguration can lead to scenarios where the cache might be running empty while the scheduler is running a few minutes/seconds late. With an empty cache, authentication requests from applications might not be immediately authorized util the scheduled loader has had a chance to re-populate and reconstruct the cache.

    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.