WORKERS AHEAD!

You are viewing the development documentation for the Apereo CAS server. The functionality presented here is not officially released yet. This is a work in progress and will be continually updated as development moves forward. You are most encouraged to test the changes presented.

Long Term Authentication

This feature, also known as Remember Me, extends the length of the SSO session beyond the typical period of hours such that users can go days or weeks without having to log in to CAS. See the security guide for discussion of security concerns related to long term authentication.

Policy and Deployment Considerations

While users can elect to establish a long term authentication session, the duration is established through configuration as a matter of security policy. Deployers must determine the length of long term authentication sessions by weighing convenience against security risks.

The use of long term authentication sessions dramatically increases the length of time ticket-granting tickets are stored in the ticket registry. Loss of a ticket-granting ticket corresponding to a long-term SSO session would require the user to re-authenticate to CAS. A security policy that requires that long term authentication sessions MUST NOT be terminated prior to their natural expiration would mandate a ticket registry component that provides for durable storage, such as the JPA Ticket Registry.

Configuration

Adjust your expiration policy so that remember-me authentication requests are handled via a long-term timeout expiration policy, and other requests are handled via the CAS default SSO session expiration policy.

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

cas.tgc.crypto.encryption.key=

The encryption key is a JWT whose length is defined by the encryption key size setting.

This setting supports the Spring Expression Language.

org.apereo.cas.configuration.model.core.util.EncryptionJwtCryptoProperties.

_{How can I configure this property?}

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

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.tgc.crypto.encryption.key=...

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: 
  tgc: 
    crypto: 
      encryption: 
        key: "..."

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.tgc.crypto.encryption.key="..." -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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_TGC_CRYPTO_ENCRYPTION_KEY="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.tgc.crypto.encryption.key="..."

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

cas.tgc.crypto.signing.key=

The signing key is a JWT whose length is defined by the signing key size setting.

This setting supports the Spring Expression Language.

org.apereo.cas.configuration.model.core.util.SigningJwtCryptoProperties.

_{How can I configure this property?}

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

Note

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

cas.tgc.crypto.signing.key=...

CAS properties can be specified using the YAML syntax:

cas: 
  tgc: 
    crypto: 
      signing: 
        key: "..."

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.tgc.crypto.signing.key="..." -jar build/libs/cas.war

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

export CAS_TGC_CRYPTO_SIGNING_KEY="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.tgc.crypto.signing.key="..."

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

_{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.tgc.allowed-ip-addresses-pattern=

A regular expression pattern that indicates the set of allowed IP addresses, when #isPinToSession() is configured. In the event that there is a mismatch between the cookie IP address and the current request-provided IP address (i.e. network switches, VPN, etc), the cookie can still be considered valid if the new IP address matches the pattern specified here.

This settings supports regular expression patterns. ^[?].

org.apereo.cas.configuration.model.support.cookie.TicketGrantingCookieProperties.

_{How can I configure this property?}

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

Note

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

cas.tgc.allowed-ip-addresses-pattern=...

CAS properties can be specified using the YAML syntax:

cas: 
  tgc: 
    allowed-ip-addresses-pattern: "..."

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.tgc.allowed-ip-addresses-pattern="..." -jar build/libs/cas.war

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

export CAS_TGC_ALLOWED_IP_ADDRESSES_PATTERN="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.tgc.allowed-ip-addresses-pattern="..."

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

cas.tgc.auto-configure-cookie-path=true

Decide if cookie paths should be automatically configured based on the application context path, when the cookie path is not configured.

org.apereo.cas.configuration.model.support.cookie.TicketGrantingCookieProperties.

_{How can I configure this property?}

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

Note

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

cas.tgc.auto-configure-cookie-path=true

CAS properties can be specified using the YAML syntax:

cas: 
  tgc: 
    auto-configure-cookie-path: "true"

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.tgc.auto-configure-cookie-path="true" -jar build/libs/cas.war

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

export CAS_TGC_AUTO_CONFIGURE_COOKIE_PATH="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.tgc.auto-configure-cookie-path="true"

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

cas.tgc.domain=

Cookie domain. Specifies the domain within which this cookie should be presented. The form of the domain name is specified by RFC 2965. A domain name begins with a dot (.foo.com) and means that the cookie is visible to servers in a specified Domain Name System (DNS) zone (for example, www.foo.com, but not a.b.foo.com). By default, cookies are only returned to the server that sent them.

org.apereo.cas.configuration.model.support.cookie.TicketGrantingCookieProperties.

_{How can I configure this property?}

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

Note

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

cas.tgc.domain=...

CAS properties can be specified using the YAML syntax:

cas: 
  tgc: 
    domain: "..."

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.tgc.domain="..." -jar build/libs/cas.war

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

export CAS_TGC_DOMAIN="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.tgc.domain="..."

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

cas.tgc.geo-locate-client-session=false

When set to true and assuming #isPinToSession() is also true, client sessions (using the client IP address) are geo-located using a geolocation service when/if configured. The resulting session is either pinned to the client geolocation, or the default client address.

org.apereo.cas.configuration.model.support.cookie.TicketGrantingCookieProperties.

_{How can I configure this property?}

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

Note

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

cas.tgc.geo-locate-client-session=...

CAS properties can be specified using the YAML syntax:

cas: 
  tgc: 
    geo-locate-client-session: "..."

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.tgc.geo-locate-client-session="..." -jar build/libs/cas.war

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

export CAS_TGC_GEO_LOCATE_CLIENT_SESSION="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.tgc.geo-locate-client-session="..."

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

cas.tgc.http-only=true

true if this cookie contains the HttpOnly attribute. This means that the cookie should not be accessible to scripting engines, like javascript.

org.apereo.cas.configuration.model.support.cookie.TicketGrantingCookieProperties.

_{How can I configure this property?}

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

Note

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

cas.tgc.http-only=true

CAS properties can be specified using the YAML syntax:

cas: 
  tgc: 
    http-only: "true"

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.tgc.http-only="true" -jar build/libs/cas.war

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

export CAS_TGC_HTTP_ONLY="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.tgc.http-only="true"

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

cas.tgc.max-age=-1

The maximum age of the cookie, specified in seconds. By default, -1 indicating the cookie will persist until browser shutdown. A positive value indicates that the cookie will expire after that many seconds have passed. Note that the value is the maximum age when the cookie will expire, not the cookie's current age. A negative value means that the cookie is not stored persistently and will be deleted when the Web browser exits. A zero value causes the cookie to be deleted.

This settings supports the java.time.Duration syntax ^[?].

org.apereo.cas.configuration.model.support.cookie.TicketGrantingCookieProperties.

_{How can I configure this property?}

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

Note

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

cas.tgc.max-age=-1

CAS properties can be specified using the YAML syntax:

cas: 
  tgc: 
    max-age: "-1"

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.tgc.max-age="-1" -jar build/libs/cas.war

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

export CAS_TGC_MAX_AGE="-1"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.tgc.max-age="-1"

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

cas.tgc.name=

Cookie name. Constructs a cookie with a specified name and value. The name must conform to RFC 2965. That means it can contain only ASCII alphanumeric characters and cannot contain commas, semicolons, or white space or begin with a $ character. The cookie's name cannot be changed after creation. By default, cookies are created according to the RFC 2965 cookie specification. Cookie names are automatically calculated assigned by CAS at runtime, and there is usually no need to customize the name or assign it a different value unless a special use case warrants the change.

org.apereo.cas.configuration.model.support.cookie.TicketGrantingCookieProperties.

_{How can I configure this property?}

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

Note

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

cas.tgc.name=...

CAS properties can be specified using the YAML syntax:

cas: 
  tgc: 
    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.tgc.name="..." -jar build/libs/cas.war

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

export CAS_TGC_NAME="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.tgc.name="..."

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

cas.tgc.path=

Cookie path. Specifies a path for the cookie to which the client should return the cookie. The cookie is visible to all the pages in the directory you specify, and all the pages in that directory's subdirectories. A cookie's path must include the servlet that set the cookie, for example, /catalog, which makes the cookie visible to all directories on the server under /catalog. Consult RFC 2965 (available on the Internet) for more information on setting path names for cookies.

org.apereo.cas.configuration.model.support.cookie.TicketGrantingCookieProperties.

_{How can I configure this property?}

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

Note

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

cas.tgc.path=...

CAS properties can be specified using the YAML syntax:

cas: 
  tgc: 
    path: "..."

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.tgc.path="..." -jar build/libs/cas.war

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

export CAS_TGC_PATH="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.tgc.path="..."

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

cas.tgc.pin-to-session=true

When generating cookie values, determine whether the value should be compounded and signed with the properties of the current session, such as IP address, user-agent, etc.

org.apereo.cas.configuration.model.support.cookie.TicketGrantingCookieProperties.

_{How can I configure this property?}

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

Note

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

cas.tgc.pin-to-session=true

CAS properties can be specified using the YAML syntax:

cas: 
  tgc: 
    pin-to-session: "true"

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.tgc.pin-to-session="true" -jar build/libs/cas.war

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

export CAS_TGC_PIN_TO_SESSION="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.tgc.pin-to-session="true"

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

cas.tgc.remember-me-max-age=P14D

If remember-me is enabled, specifies the maximum age of the cookie.

This settings supports the java.time.Duration syntax ^[?].

org.apereo.cas.configuration.model.support.cookie.TicketGrantingCookieProperties.

_{How can I configure this property?}

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

Note

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

cas.tgc.remember-me-max-age=P14D

CAS properties can be specified using the YAML syntax:

cas: 
  tgc: 
    remember-me-max-age: "P14D"

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.tgc.remember-me-max-age="P14D" -jar build/libs/cas.war

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

export CAS_TGC_REMEMBER_ME_MAX_AGE="P14D"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.tgc.remember-me-max-age="P14D"

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

cas.tgc.same-site-policy=

If a cookie is only intended to be accessed in a first party context, the developer has the option to apply one of settings SameSite=Lax or SameSite=Strict or SameSite=None to prevent external access.

To safeguard more websites and their users, the new secure-by-default model assumes all cookies should be protected from external access unless otherwise specified. Developers must use a new cookie setting, SameSite=None, to designate cookies for cross-site access. When the SameSite=None attribute is present, an additional Secure attribute is used so cross-site cookies can only be accessed over HTTPS connections.

Accepted values are:

Lax
Strict
None
Off: Disable the generation of the SameSite cookie attribute altogether.
Path to a Groovy script that is able to generate the SameSite cookie attribute dynamically.
Fully qualified name of a class that implements org.apereo.cas.web.cookie.CookieSameSitePolicy

org.apereo.cas.configuration.model.support.cookie.TicketGrantingCookieProperties.

_{How can I configure this property?}

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

Note

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

cas.tgc.same-site-policy=...

CAS properties can be specified using the YAML syntax:

cas: 
  tgc: 
    same-site-policy: "..."

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.tgc.same-site-policy="..." -jar build/libs/cas.war

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

export CAS_TGC_SAME_SITE_POLICY="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.tgc.same-site-policy="..."

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

cas.tgc.secure=true

True if sending this cookie should be restricted to a secure protocol, or false if the it can be sent using any protocol.

org.apereo.cas.configuration.model.support.cookie.TicketGrantingCookieProperties.

_{How can I configure this property?}

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

Note

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

cas.tgc.secure=true

CAS properties can be specified using the YAML syntax:

cas: 
  tgc: 
    secure: "true"

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.tgc.secure="true" -jar build/libs/cas.war

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

export CAS_TGC_SECURE="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.tgc.secure="true"

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

cas.tgc.crypto.alg=

The signing/encryption algorithm to use.

org.apereo.cas.configuration.model.core.util.EncryptionJwtSigningJwtCryptographyProperties.

_{How can I configure this property?}

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

Note

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

cas.tgc.crypto.alg=...

CAS properties can be specified using the YAML syntax:

cas: 
  tgc: 
    crypto: 
      alg: "..."

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.tgc.crypto.alg="..." -jar build/libs/cas.war

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

export CAS_TGC_CRYPTO_ALG="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.tgc.crypto.alg="..."

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

cas.tgc.crypto.enabled=true

Whether crypto operations are enabled.

org.apereo.cas.configuration.model.core.util.EncryptionJwtSigningJwtCryptographyProperties.

_{How can I configure this property?}

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

Note

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

cas.tgc.crypto.enabled=true

CAS properties can be specified using the YAML syntax:

cas: 
  tgc: 
    crypto: 
      enabled: "true"

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.tgc.crypto.enabled="true" -jar build/libs/cas.war

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

export CAS_TGC_CRYPTO_ENABLED="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.tgc.crypto.enabled="true"

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

cas.tgc.crypto.encryption.key-size=512

The encryption key size.

org.apereo.cas.configuration.model.core.util.EncryptionJwtCryptoProperties.

_{How can I configure this property?}

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

Note

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

cas.tgc.crypto.encryption.key-size=512

CAS properties can be specified using the YAML syntax:

cas: 
  tgc: 
    crypto: 
      encryption: 
        key-size: "512"

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.tgc.crypto.encryption.key-size="512" -jar build/libs/cas.war

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

export CAS_TGC_CRYPTO_ENCRYPTION_KEY_SIZE="512"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.tgc.crypto.encryption.key-size="512"

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

cas.tgc.crypto.signing.key-size=512

The signing key size.

org.apereo.cas.configuration.model.core.util.SigningJwtCryptoProperties.

_{How can I configure this property?}

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

Note

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

cas.tgc.crypto.signing.key-size=512

CAS properties can be specified using the YAML syntax:

cas: 
  tgc: 
    crypto: 
      signing: 
        key-size: "512"

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.tgc.crypto.signing.key-size="512" -jar build/libs/cas.war

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

export CAS_TGC_CRYPTO_SIGNING_KEY_SIZE="512"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.tgc.crypto.signing.key-size="512"

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

cas.tgc.crypto.strategy-type=ENCRYPT_AND_SIGN

Control the cipher sequence of operations. The accepted values are:

ENCRYPT_AND_SIGN: Encrypt the value first, and then sign.
SIGN_AND_ENCRYPT: Sign the value first, and then encrypt.

org.apereo.cas.configuration.model.core.util.EncryptionJwtSigningJwtCryptographyProperties.

_{How can I configure this property?}

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

Note

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

cas.tgc.crypto.strategy-type=ENCRYPT_AND_SIGN

CAS properties can be specified using the YAML syntax:

cas: 
  tgc: 
    crypto: 
      strategy-type: "ENCRYPT_AND_SIGN"

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.tgc.crypto.strategy-type="ENCRYPT_AND_SIGN" -jar build/libs/cas.war

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

export CAS_TGC_CRYPTO_STRATEGY_TYPE="ENCRYPT_AND_SIGN"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.tgc.crypto.strategy-type="ENCRYPT_AND_SIGN"

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

cas.ticket.tgt.remember-me.enabled=false

Flag to indicate whether remember-me facility is enabled.

org.apereo.cas.configuration.model.core.ticket.RememberMeAuthenticationProperties.

_{How can I configure this property?}

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

Note

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

cas.ticket.tgt.remember-me.enabled=...

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    tgt: 
      remember-me: 
        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.ticket.tgt.remember-me.enabled="..." -jar build/libs/cas.war

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

export CAS_TICKET_TGT_REMEMBER_ME_ENABLED="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.ticket.tgt.remember-me.enabled="..."

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

cas.ticket.tgt.remember-me.supported-ip-addresses=

Regular expression that, when defined, forces CAS to create a remember-me authentication session if the current client ip (remote) address matches this pattern. If a match is not found, remember-me is ignored. If left undefined, remember-me authentication will proceed with the default CAS behavior.

This settings supports regular expression patterns. ^[?].

org.apereo.cas.configuration.model.core.ticket.RememberMeAuthenticationProperties.

_{How can I configure this property?}

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

Note

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

cas.ticket.tgt.remember-me.supported-ip-addresses=...

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    tgt: 
      remember-me: 
        supported-ip-addresses: "..."

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.ticket.tgt.remember-me.supported-ip-addresses="..." -jar build/libs/cas.war

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

export CAS_TICKET_TGT_REMEMBER_ME_SUPPORTED_IP_ADDRESSES="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.ticket.tgt.remember-me.supported-ip-addresses="..."

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

cas.ticket.tgt.remember-me.supported-user-agents=

Regular expression that, when defined, forces CAS to create a remember-me authentication session if the current user-agent matches this pattern. If a match is not found, remember-me is ignored. If left undefined, remember-me authentication will proceed with the default CAS behavior.

This settings supports regular expression patterns. ^[?].

org.apereo.cas.configuration.model.core.ticket.RememberMeAuthenticationProperties.

_{How can I configure this property?}

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

Note

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

cas.ticket.tgt.remember-me.supported-user-agents=...

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    tgt: 
      remember-me: 
        supported-user-agents: "..."

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.ticket.tgt.remember-me.supported-user-agents="..." -jar build/libs/cas.war

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

export CAS_TICKET_TGT_REMEMBER_ME_SUPPORTED_USER_AGENTS="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.ticket.tgt.remember-me.supported-user-agents="..."

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

cas.ticket.tgt.remember-me.time-to-kill-in-seconds=P14D

Time in seconds after which remember-me enabled SSO session will be destroyed.

This settings supports the java.time.Duration syntax ^[?].

org.apereo.cas.configuration.model.core.ticket.RememberMeAuthenticationProperties.

_{How can I configure this property?}

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

Note

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

cas.ticket.tgt.remember-me.time-to-kill-in-seconds=P14D

CAS properties can be specified using the YAML syntax:

cas: 
  ticket: 
    tgt: 
      remember-me: 
        time-to-kill-in-seconds: "P14D"

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.ticket.tgt.remember-me.time-to-kill-in-seconds="P14D" -jar build/libs/cas.war

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

export CAS_TICKET_TGT_REMEMBER_ME_TIME_TO_KILL_IN_SECONDS="P14D"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.ticket.tgt.remember-me.time-to-kill-in-seconds="P14D"

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

# A regular expression pattern that indicates the set of allowed IP addresses, when {@link #isPinToSession()} is configured.
# cas.tgc.allowed-ip-addresses-pattern=

# Decide if cookie paths should be automatically configured based on the application context path, when the cookie path is not configured.
# cas.tgc.auto-configure-cookie-path=true

# Cookie domain.
# cas.tgc.domain=

# When set to {@code true} and assuming {@link #isPinToSession()} is also {@code true}, client sessions (using the client IP address) are geo-located using a geolocation service when/if configured.
# cas.tgc.geo-locate-client-session=false

# true if this cookie contains the HttpOnly attribute.
# cas.tgc.http-only=true

# The maximum age of the cookie, specified in seconds.
# cas.tgc.max-age=-1

# Cookie name.
# cas.tgc.name=

# Cookie path.
# cas.tgc.path=

# When generating cookie values, determine whether the value should be compounded and signed with the properties of the current session, such as IP address, user-agent, etc.
# cas.tgc.pin-to-session=true

# If remember-me is enabled, specifies the maximum age of the cookie.
# cas.tgc.remember-me-max-age=P14D

# If a cookie is only intended to be accessed in a first party context, the developer has the option to apply one of settings {@code SameSite=Lax} or {@code SameSite=Strict} or {@code SameSite=None} to prevent external access.
# cas.tgc.same-site-policy=

# True if sending this cookie should be restricted to a secure protocol, or false if the it can be sent using any protocol.
# cas.tgc.secure=true

# The signing/encryption algorithm to use.
# cas.tgc.crypto.alg=

# Whether crypto operations are enabled.
# cas.tgc.crypto.enabled=true

# The encryption key size.
# cas.tgc.crypto.encryption.key-size=512

# The signing key size.
# cas.tgc.crypto.signing.key-size=512

# Control the cipher sequence of operations.
# cas.tgc.crypto.strategy-type=ENCRYPT_AND_SIGN

# Flag to indicate whether remember-me facility is enabled.
# cas.ticket.tgt.remember-me.enabled=false

# Regular expression that, when defined, forces CAS to create a remember-me authentication session if the current client ip (remote) address matches this pattern.
# cas.ticket.tgt.remember-me.supported-ip-addresses=

# Regular expression that, when defined, forces CAS to create a remember-me authentication session if the current user-agent matches this pattern.
# cas.ticket.tgt.remember-me.supported-user-agents=

# Time in seconds after which remember-me enabled SSO session will be destroyed.
# cas.ticket.tgt.remember-me.time-to-kill-in-seconds=P14D

cas.tgc.crypto.encryption.key=

The encryption key is a JWT whose length is defined by the encryption key size setting.

This setting supports the Spring Expression Language.

org.apereo.cas.configuration.model.core.util.EncryptionJwtCryptoProperties.

_{How can I configure this property?}

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

Note

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

cas.tgc.crypto.encryption.key=...

CAS properties can be specified using the YAML syntax:

cas: 
  tgc: 
    crypto: 
      encryption: 
        key: "..."

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.tgc.crypto.encryption.key="..." -jar build/libs/cas.war

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

export CAS_TGC_CRYPTO_ENCRYPTION_KEY="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.tgc.crypto.encryption.key="..."

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

cas.tgc.crypto.signing.key=

The signing key is a JWT whose length is defined by the signing key size setting.

This setting supports the Spring Expression Language.

org.apereo.cas.configuration.model.core.util.SigningJwtCryptoProperties.

_{How can I configure this property?}

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

Note

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

cas.tgc.crypto.signing.key=...

CAS properties can be specified using the YAML syntax:

cas: 
  tgc: 
    crypto: 
      signing: 
        key: "..."

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.tgc.crypto.signing.key="..." -jar build/libs/cas.war

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

export CAS_TGC_CRYPTO_SIGNING_KEY="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.tgc.crypto.signing.key="..."

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

cas.tgc.crypto.alg=

The signing/encryption algorithm to use.

org.apereo.cas.configuration.model.core.util.EncryptionJwtSigningJwtCryptographyProperties.

_{How can I configure this property?}

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

Note

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

cas.tgc.crypto.alg=...

CAS properties can be specified using the YAML syntax:

cas: 
  tgc: 
    crypto: 
      alg: "..."

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.tgc.crypto.alg="..." -jar build/libs/cas.war

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

export CAS_TGC_CRYPTO_ALG="..."

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.tgc.crypto.alg="..."

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

cas.tgc.crypto.enabled=true

Whether crypto operations are enabled.

org.apereo.cas.configuration.model.core.util.EncryptionJwtSigningJwtCryptographyProperties.

_{How can I configure this property?}

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

Note

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

cas.tgc.crypto.enabled=true

CAS properties can be specified using the YAML syntax:

cas: 
  tgc: 
    crypto: 
      enabled: "true"

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.tgc.crypto.enabled="true" -jar build/libs/cas.war

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

export CAS_TGC_CRYPTO_ENABLED="true"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.tgc.crypto.enabled="true"

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

cas.tgc.crypto.encryption.key-size=512

The encryption key size.

org.apereo.cas.configuration.model.core.util.EncryptionJwtCryptoProperties.

_{How can I configure this property?}

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

Note

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

cas.tgc.crypto.encryption.key-size=512

CAS properties can be specified using the YAML syntax:

cas: 
  tgc: 
    crypto: 
      encryption: 
        key-size: "512"

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.tgc.crypto.encryption.key-size="512" -jar build/libs/cas.war

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

export CAS_TGC_CRYPTO_ENCRYPTION_KEY_SIZE="512"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.tgc.crypto.encryption.key-size="512"

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

cas.tgc.crypto.signing.key-size=512

The signing key size.

org.apereo.cas.configuration.model.core.util.SigningJwtCryptoProperties.

_{How can I configure this property?}

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

Note

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

cas.tgc.crypto.signing.key-size=512

CAS properties can be specified using the YAML syntax:

cas: 
  tgc: 
    crypto: 
      signing: 
        key-size: "512"

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.tgc.crypto.signing.key-size="512" -jar build/libs/cas.war

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

export CAS_TGC_CRYPTO_SIGNING_KEY_SIZE="512"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.tgc.crypto.signing.key-size="512"

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

cas.tgc.crypto.strategy-type=ENCRYPT_AND_SIGN

Control the cipher sequence of operations. The accepted values are:

ENCRYPT_AND_SIGN: Encrypt the value first, and then sign.
SIGN_AND_ENCRYPT: Sign the value first, and then encrypt.

org.apereo.cas.configuration.model.core.util.EncryptionJwtSigningJwtCryptographyProperties.

_{How can I configure this property?}

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

Note

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

cas.tgc.crypto.strategy-type=ENCRYPT_AND_SIGN

CAS properties can be specified using the YAML syntax:

cas: 
  tgc: 
    crypto: 
      strategy-type: "ENCRYPT_AND_SIGN"

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.tgc.crypto.strategy-type="ENCRYPT_AND_SIGN" -jar build/libs/cas.war

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

export CAS_TGC_CRYPTO_STRATEGY_TYPE="ENCRYPT_AND_SIGN"

java -jar build/libs/cas.war

The above example assumes that the CAS web application is packaged as cas.war with an embedded server container 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.tgc.crypto.strategy-type="ENCRYPT_AND_SIGN"

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

This CAS feature is able to accept signing and encryption crypto keys. In most scenarios if keys are not provided, CAS will auto-generate them. The following instructions apply if you wish to manually and beforehand create the signing and encryption keys.

Note that if you are asked to create a JWK of a certain size for the key, you are to use the following set of commands to generate the token:

wget https://raw.githubusercontent.com/apereo/cas/master/etc/jwk-gen.jar
java -jar jwk-gen.jar -t oct -s [size]

The outcome would be similar to:

{
  "kty": "oct",
  "kid": "...",
  "k": "..."
}

The generated value for k needs to be assigned to the relevant CAS settings. Note that keys generated via the above algorithm are processed by CAS using the Advanced Encryption Standard (AES) algorithm which is a specification for the encryption of electronic data established by the U.S. National Institute of Standards and Technology.

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

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.