Attribute Release Caching

By default, resolved attributes are cached to the length of the SSO session. If there are any attribute value changes since the commencement of SSO session, the changes are not reflected and returned back to the service upon release 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. In other words, you should only include this field in your configuration if you need to modify the default value or if you need to turn on the feature controlled by the setting.

  • cas.authn.attribute-repository.core.aggregation=MERGE

    • Indicates how the results of multiple attribute repositories should be aggregated together. Available values are as follows:

    • MERGE: Default. Designed to query multiple repositories in order and merge the results into a single result set.
    • CASCADE: Query multiple repositories in order and merge the results into a single result set. As each repository is queried the attributes from the first query in the result set are used as the query for the next repository.

    org.apereo.cas.configuration.model.core.authentication.PrincipalAttributesCoreProperties.

    How can I configure this property?

  • cas.authn.attribute-repository.core.default-attributes-to-release=

    • CAS provides the ability to release a bundle of principal attributes to all services by default. This bundle is not defined on a per-service basis and is always combined with attributes produced by the specific release policy of the service, such that for instance, you can devise rules to always release givenName and cn to every application, and additionally allow other specific principal attributes for only some applications per their attribute release policy.

    org.apereo.cas.configuration.model.core.authentication.PrincipalAttributesCoreProperties.

    How can I configure this property?

  • cas.authn.attribute-repository.core.expiration-time=30

    • Indicates the global cache expiration period, once attributes are fetched from the underlying attribute repository. A zero or negative value indicates that no attribute caching should take place where attributes must always be fetched from the source.

    org.apereo.cas.configuration.model.core.authentication.PrincipalAttributesCoreProperties.

    How can I configure this property?

  • cas.authn.attribute-repository.core.expiration-time-unit=

    • Expiration caching time unit for attributes.

    org.apereo.cas.configuration.model.core.authentication.PrincipalAttributesCoreProperties.

    How can I configure this property?

  • cas.authn.attribute-repository.core.maximum-cache-size=10000

    • Indicates the global cache size used to store attributes retrieved from the attribute repository.

    org.apereo.cas.configuration.model.core.authentication.PrincipalAttributesCoreProperties.

    How can I configure this property?

  • cas.authn.attribute-repository.core.merger=REPLACE

    • Merging strategies can be used to resolve conflicts when the same attributes are found from multiple sources. A merging strategy is used to handle conflicts for both principal attributes as well as those that are captured by the authentication attempt. Conflicts arise when the multiple attribute sources or repositories produce the same attribute with the same name, or when there are multiple legs in an authentication flow that produce the same attribute as authentication metadata for each leg of the attempt (i.e. when going through MFA flows). Available values are as follows:

    • REPLACE: Replace attributes. Overwrites existing attribute values, if any.
    • ADD: Add attributes. Retains existing attribute values if any, and ignores values from subsequent sources in the resolution chain.
    • SOURCE: No merging. Doesn't merge attributes, and returns the original collection of attributes as passed.
    • DESTINATION: No merging. Ignore the collection of original attributes that are passed and always favor what is supplied as a subsequent source and an override.
    • MULTIVALUED: Multivalued attributes. Combines all values into a single attribute, essentially creating a multi-valued attribute.

    org.apereo.cas.configuration.model.core.authentication.PrincipalAttributesCoreProperties.

    How can I configure this property?

  • cas.authn.attribute-repository.core.recover-exceptions=true

    • Recover from LDAP exceptions and continue with partial results. Otherwise, die and do not allow to log in.

    org.apereo.cas.configuration.model.core.authentication.PrincipalAttributesCoreProperties.

    How can I configure this property?

  • cas.authn.attribute-repository.core.require-all-repository-sources=false

    • In the event that multiple attribute repositories are defined, setting this option to true forces all repositories to produce a person object. If any of the repositories fails to produce a person or person attributes, the resolution engine will halt to short-circuit the process, failing to resolve the person altogether.

    org.apereo.cas.configuration.model.core.authentication.PrincipalAttributesCoreProperties.

    How can I configure this property?

  • cas.authn.attribute-repository.core.stop-cascading-when-no-initial-results=true

    • When #aggregation is set to AggregationStrategyTypes#CASCADE, this setting controls whether subsequent attribute repositories need to be contacted for person attributes, if the first attribute repository's query does not produce any results.

    org.apereo.cas.configuration.model.core.authentication.PrincipalAttributesCoreProperties.

    How can I configure this property?

    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.

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

    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.

    Principal Attribute Repositories

    The following settings are shared by all principal attribute repositories:

    Name Value
    mergingStrategy Indicate the merging strategy when combining attributes from multiple sources. Accepted values are MULTIVALUED, ADD, NONE, MULTIVALUED
    attributeRepositoryIds A Set of attribute repository identifiers to consult for attribute resolution at release time.
    ignoreResolvedAttributes Ignore the collection of attributes that may have been resolved during the principal resolution phase, typically via attribute repositories.

    The following caching strategies are offered by CAS:

    • The default relationship between a CAS Principal and the underlying attribute repository source, such that principal attributes are kept as they are without any additional processes to evaluate and update them. This need not be configured explicitly.

    • The relationship between a CAS Principal and the underlying attribute repository source, that describes how and at what length the CAS Principal attributes should be cached. Upon attribute release time, this component is consulted to ensure that appropriate attribute values are released to the scoped service, per the cache expiration policy. If the expiration policy has passed, the underlying attribute repository source will be consulted to figure out the available set of attributes.

      This component also has the ability to resolve conflicts between existing principal attributes and those that are retrieved from repository source via a mergingStrategy property. This is useful if you want to preserve the collection of attributes that are already available to the principal that were retrieved from a different place during the authentication event, etc.

      :information_source: Caching Upon Release

      Note that the policy is only consulted at release time, upon a service ticket validation event. If there are any custom webflows and such that wish to rely on the resolved Principal AND also wish to receive an updated set of attributes, those components must consult the underlying source directory without relying on the Principal.

      Sample configuration follows:

      

      1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

      		

      {
  "@class" : "org.apereo.cas.services.CasRegisteredService",
  "serviceId" : "sample",
  "name" : "sample",
  "id" : 100,
  "attributeReleasePolicy" : {
    "@class" : "org.apereo.cas.services.ReturnAllowedAttributeReleasePolicy",
    "principalAttributesRepository" : {
      "@class" : "org.apereo.cas.authentication.principal.cache.CachingPrincipalAttributesRepository",
      "timeUnit" : "HOURS",
      "expiration" : 2,
      "mergingStrategy" : "NONE"
    }
  }
}

    Merging Strategies

    By default, no merging strategy takes place, which means the principal attributes are always ignored and attributes from the source are always returned. But any of the following merging strategies may be a suitable option:

    • Attributes with the same name are merged into multi-valued lists.

      For example:

      1. Principal has attributes {email=eric.dalquist@example.com, phone=123-456-7890}
      2. Source has attributes {phone=[111-222-3333, 000-999-8888], office=3233}
      3. The resulting merged would have attributes: {email=eric.dalquist@example.com, phone=[123-456-7890, 111-222-3333, 000-999-8888], office=3233} 
      

      1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

      		

      {
  "@class" : "org.apereo.cas.services.CasRegisteredService",
  "serviceId" : "sample",
  "name" : "sample",
  "id" : 100,
  "attributeReleasePolicy" : {
    "@class" : "org.apereo.cas.services.ReturnAllowedAttributeReleasePolicy",
    "principalAttributesRepository" : {
      "@class" : "org.apereo.cas.authentication.principal.cache.CachingPrincipalAttributesRepository",
      "timeUnit" : "HOURS",
      "expiration" : 2,
      "mergingStrategy" : "MULTIVALUED"
    }
  }
}

    • Attributes are merged such that attributes from the source that don’t already exist for the principal are produced.

      For example:

      1. Principal has attributes {email=eric.dalquist@example.com, phone=123-456-7890}
      2. Source has attributes {phone=[111-222-3333, 000-999-8888], office=3233}
      3. The resulting merged would have attributes: {email=eric.dalquist@example.com, phone=123-456-7890, office=3233} 
      

      1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

      		

      {
  "@class" : "org.apereo.cas.services.CasRegisteredService",
  "serviceId" : "sample",
  "name" : "sample",
  "id" : 100,
  "attributeReleasePolicy" : {
    "@class" : "org.apereo.cas.services.ReturnAllowedAttributeReleasePolicy",
    "principalAttributesRepository" : {
      "@class" : "org.apereo.cas.authentication.principal.cache.CachingPrincipalAttributesRepository",
      "timeUnit" : "HOURS",
      "expiration" : 2,
      "mergingStrategy" : "ADD"
    }
  }
}

    • Attributes are merged such that attributes from the source always replace principal attributes.

      For example:

      1. Principal has attributes {email=eric.dalquist@example.com, phone=123-456-7890}
      2. Source has attributes {phone=[111-222-3333, 000-999-8888], office=3233}
      3. The resulting merged would have attributes: {email=eric.dalquist@example.com, phone=[111-222-3333, 000-999-8888], office=3233} 
      

      1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

      		

      {
  "@class" : "org.apereo.cas.services.CasRegisteredService",
  "serviceId" : "sample",
  "name" : "sample",
  "id" : 100,
  "attributeReleasePolicy" : {
    "@class" : "org.apereo.cas.services.ReturnAllowedAttributeReleasePolicy",
    "principalAttributesRepository" : {
      "@class" : "org.apereo.cas.authentication.principal.cache.CachingPrincipalAttributesRepository",
      "timeUnit" : "HOURS",
      "expiration" : 2,
      "mergingStrategy" : "REPLACE"
    }
  }
}