APEREO CASDocumentation

Enterprise Authentication for All Earthlings and Beyond

Identity, Single Sign-On and Access Management
View on GitHub

Client Secret Management - OAuth Authentication

By default, client secrets are directly assigned to the client application:



1
2
3
4
5
6
7



{
  "@class" : "org.apereo.cas.support.oauth.services.OAuthRegisteredService",
  "name" : "...",
  "clientId": "...",
  "clientSecret": "your-client-secret",
  "serviceId" : "...",
}

The above setup indicates that the application has a simple static client secret assigned without an expiration date. Also, note that client secret values can use the Spring Expression Language syntax.

:information_source: Note

The client secret construct above is mainly kept for backward compatibility reasons. Internally, CAS translates this client secret value to a polymorphic type that is outlined below. You may continue using this legacy setup if you have no need for additional behavior that can be attached to client secrets, such as expirations and ability to rotate them.

Multiple Client Secrets

You may also define multiple client secrets for a client application and assign them each a dedicated (and yet optional) expiration value:



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



{
  "@class" : "org.apereo.cas.support.oauth.services.OAuthRegisteredService",
  "name" : "...",
  "serviceId" : "...",
  "clientSecrets" : [ "java.util.ArrayList", [ 
    {
      "@class" : "org.apereo.cas.support.oauth.services.OAuthRegisteredServiceClientSecret",
      "value" : "<secret-value1>",
      "expiration" : 1234567890
    },
    {
      "@class" : "org.apereo.cas.support.oauth.services.OAuthRegisteredServiceClientSecret",
      "value" : "<secret-value2>",
      "expiration" : "09/21/2026"
    },
  ] ],
  "clientId" : "..."
}

When processing requests, CAS will iterate over the list of client secrets, disregarding those that might be expired already. The request is allowed to proceed if a valid non-expiring client secret from the assigned list can be authenticated.

Client Secret Expiration

When a client secret defines an expiration value, CAS ultimately treats and transforms that value as a Unix epoch timestamp in seconds. The timestamp is converted into a UTC timezone and truncated to second precision if needed. The current UTC time is also truncated to second precision so both values are compared consistently. If the current time is after the configured expiration time, the client secret is considered expired and rejected.

A shortcut for calculating a client secret set to expire 2 weeks from now would be:



1
2
3
4
5
6



#!/usr/bin/env python3

from datetime import datetime, timedelta, timezone

expires_at = datetime.now(timezone.utc) + timedelta(weeks=2)
print(int(expires_at.timestamp()))

…or perhaps in bash:



1
2
3
4



# On macOS/BSD
date -u -v+2w +%s
# On Linux/GNU
date -u -d '+2 weeks' +%s

The expiration field may be specified as either a UTC epoch timestamp in seconds or as a date/time string. Supported formats include:

Format Example
Epoch seconds 2051223845
ISO local date/time 2035-01-02T03:04:05
ISO zoned date/time 2035-01-02T03:04:05Z
12-hour date/time with padded hour 01/02/2035 03:04 AM
12-hour date/time with non-padded hour 01/02/2035 3:04 AM
24-hour date/time 01/02/2035 03:04
Date only 01/02/2035
ISO date only 2035-01-02

Epoch values are interpreted as seconds since the Unix epoch is in UTC. Date/time values that do not include a timezone are interpreted in UTC. Formats that do not include seconds are resolved at minute precision.

Actuator Endpoints

The following endpoints are provided by CAS:

oauthClientSecrets
CAS endpoint1 operationNot exposed by default
1

Turn the endpoint on and expose it over the web. One entry covers every operation. By default only info, health and status are exposed.



1
2



management.endpoint.oauthClientSecrets.access=UNRESTRICTED
management.endpoints.web.exposure.include=oauthClientSecrets

Endpoints may be mapped to other paths. For example, to serve health at healthcheck:



1



management.endpoints.web.path-mapping.health=healthcheck

Encryptable Client Secrets

Client secrets for OAuth relying parties may be defined as encrypted values prefixed with {cas-cipher}:



1
2
3
4
5
6
7
8



{
  "@class": "org.apereo.cas.support.oauth.services.OAuthRegisteredService",
  "clientId": "clientid",
  "clientSecret": "{cas-cipher}eyJhbGciOiJIUzUxMiIs...",
  "serviceId" : "^(https|imaps)://<redirect-uri>.*",
  "name": "Sample",
  "id": 100
}

Client secrets may be encrypted using CAS-provided cipher operations either manually or via the CAS Command-line shell.

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

cas.authn.oauth.access-token.crypto.encryption.keyThe encryption key is a string whose length is defined by the encryption key size setting.
no default
RequiredSpEL

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

Type
String
Default
none
Defined by
EncryptionJwtCryptoProperties
Supports
Spring Expression Language
cas.authn.oauth.access-token.crypto.signing.keyThe signing key is a string whose length is defined by the signing key size setting.
no default
RequiredSpEL

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

Type
String
Default
none
Defined by
SigningJwtCryptoProperties
Supports
Spring Expression Language
cas.authn.oauth.crypto.encryption.keyThe encryption key is a string whose length is defined by the encryption key size setting.
no default
RequiredSpEL

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

Type
String
Default
none
Defined by
EncryptionJwtCryptoProperties
Supports
Spring Expression Language
cas.authn.oauth.crypto.signing.keyThe signing key is a string whose length is defined by the signing key size setting.
no default
RequiredSpEL

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

Type
String
Default
none
Defined by
SigningJwtCryptoProperties
Supports
Spring Expression Language
cas.authn.oauth.session-replication.cookie.crypto.encryption.keyThe encryption key is a string whose length is defined by the encryption key size setting.
no default
RequiredSpEL

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

Type
String
Default
none
Defined by
EncryptionJwtCryptoProperties
Supports
Spring Expression Language
cas.authn.oauth.session-replication.cookie.crypto.signing.keyThe signing key is a string whose length is defined by the signing key size setting.
no default
RequiredSpEL

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

Type
String
Default
none
Defined by
SigningJwtCryptoProperties
Supports
Spring Expression Language
cas.authn.oauth.uma.core.issuerUMA issuer.
http://localhost:8080/cas
Required

UMA issuer.

Type
String
Default
http://localhost:8080/cas
Defined by
UmaCoreProperties
cas.authn.oauth.uma.requesting-party-token.jwks-file.locationThe location of the resource.
no default
Required

The location of the resource. Resources can be URLs, or files found either on the classpath or outside somewhere in the file system.

In the event the configured resource is a Groovy script, especially if the script is set to reload on changes, you may need to adjust the total number of inotify instances. On Linux, you may need to add the following line to /etc/sysctl.conf: fs.inotify.max_user_instances = 256.

You can check the current value via cat /proc/sys/fs/inotify/max_user_instances.

In situations and scenarios where CAS is able to automatically watch the underlying resource for changes and detect updates and modifications dynamically, you may be able to specify the following setting as either an environment variable or system property with a value of false to disable the resource watcher: org.apereo.cas.util.io.PathWatcherService.

Type
Resource
Default
none
Defined by
SpringResourceProperties
cas.authn.oauth.uma.resource-set.jpa.driver-classThe JDBC driver used to connect to the database.
org.hsqldb.jdbcDriver
Required

The JDBC driver used to connect to the database.

Type
String
Default
org.hsqldb.jdbcDriver
Defined by
UmaResourceSetJpaProperties
cas.authn.oauth.uma.resource-set.jpa.passwordThe database connection password.
no default
Required

The database connection password.

Type
String
Default
none
Defined by
UmaResourceSetJpaProperties
cas.authn.oauth.uma.resource-set.jpa.urlThe database connection URL.
jdbc:hsqldb:mem:cas-hsql-database
RequiredSpEL

The database connection URL.

Type
String
Default
jdbc:hsqldb:mem:cas-hsql-database
Defined by
UmaResourceSetJpaProperties
Supports
Spring Expression Language
cas.authn.oauth.uma.resource-set.jpa.userThe database user.
sa
Required

The database user.

The database user must have sufficient permissions to be able to handle schema changes and updates, when needed.

Type
String
Default
sa
Defined by
UmaResourceSetJpaProperties
cas.authn.oauth.access-token.create-as-jwtCreate access token as JWTs.
false

Create access token as JWTs.

Type
Boolean
Default
false
Defined by
OAuthAccessTokenProperties
cas.authn.oauth.access-token.crypto.algThe signing/encryption algorithm to use.
no default

The signing/encryption algorithm to use.

Type
String
Default
none
Defined by
EncryptionOptionalSigningOptionalJwtCryptographyProperties
cas.authn.oauth.access-token.crypto.enabledWhether crypto operations are enabled.
true

Whether crypto operations are enabled.

Type
Boolean
Default
true
Defined by
EncryptionOptionalSigningOptionalJwtCryptographyProperties
cas.authn.oauth.access-token.crypto.encryption-enabledWhether crypto encryption operations are enabled.
true

Whether crypto encryption operations are enabled.

Type
Boolean
Default
true
Defined by
EncryptionOptionalSigningOptionalJwtCryptographyProperties
cas.authn.oauth.access-token.crypto.encryption.key-sizeThe encryption key size.
512

The encryption key size.

Type
Integer
Default
512
Defined by
EncryptionJwtCryptoProperties
cas.authn.oauth.access-token.crypto.signing-enabledWhether crypto signing operations are enabled.
true

Whether crypto signing operations are enabled.

Type
Boolean
Default
true
Defined by
EncryptionOptionalSigningOptionalJwtCryptographyProperties
cas.authn.oauth.access-token.crypto.signing.key-sizeThe signing key size.
512

The signing key size.

Type
Integer
Default
512
Defined by
SigningJwtCryptoProperties
cas.authn.oauth.access-token.crypto.strategy-typeControl the cipher sequence of operations.
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.
Type
String
Default
ENCRYPT_AND_SIGN
Defined by
EncryptionOptionalSigningOptionalJwtCryptographyProperties
cas.authn.oauth.access-token.include-claims-in-jwtWhether CAS should include extra CAS attributes as claims in the JWT access token.
true

Whether CAS should include extra CAS attributes as claims in the JWT access token. This setting is only relevant if the access token is a determined to be a JWT.

Type
Boolean
Default
true
Defined by
OAuthAccessTokenProperties
cas.authn.oauth.access-token.max-active-tokens-allowedMaximum number of active access tokens that an application can receive.
0

Maximum number of active access tokens that an application can receive. If the application requests more that this limit, the request will be denied and the access token will not be issued.

Type
Long
Default
0
Defined by
OAuthAccessTokenProperties
cas.authn.oauth.access-token.max-time-to-live-in-secondsHard timeout to kill the access token and expire it.
PT8H
Duration

Hard timeout to kill the access token and expire it.

Type
String
Default
PT8H
Defined by
OAuthAccessTokenProperties
cas.authn.oauth.access-token.storage-nameThe storage object name used and created by CAS to hold OAuth access tokens in the backing ticket registry implementation.
oauthAccessTokensCache

The storage object name used and created by CAS to hold OAuth access tokens in the backing ticket registry implementation.

Type
String
Default
oauthAccessTokensCache
Defined by
OAuthAccessTokenProperties
cas.authn.oauth.access-token.time-to-kill-in-secondsSliding window for the access token expiration policy.
PT2H
Duration

Sliding window for the access token expiration policy. Essentially, this is an idle time out.

Type
String
Default
PT2H
Defined by
OAuthAccessTokenProperties
cas.authn.oauth.code.number-of-usesNumber of times this code is valid and can be used.
1

Number of times this code is valid and can be used.

Type
Integer
Default
1
Defined by
OAuthCodeProperties
cas.authn.oauth.code.remove-related-access-tokensRemove the related access tokens when trying to use a code which is expired or no longer exists.
false

Remove the related access tokens when trying to use a code which is expired or no longer exists.

Type
Boolean
Default
false
Defined by
OAuthCodeProperties
cas.authn.oauth.code.storage-nameThe storage object name used and created by CAS to hold OAuth codes in the backing ticket registry implementation.
oauthCodesCache

The storage object name used and created by CAS to hold OAuth codes in the backing ticket registry implementation.

Type
String
Default
oauthCodesCache
Defined by
OAuthCodeProperties
cas.authn.oauth.code.time-to-kill-in-secondsDuration in seconds where the code is valid.
30

Duration in seconds where the code is valid.

Type
Long
Default
30
Defined by
OAuthCodeProperties
cas.authn.oauth.core.bypass-approval-promptWhether approval prompt/consent screen should be bypassed.
false

Whether approval prompt/consent screen should be bypassed.

Type
Boolean
Default
false
Defined by
OAuthCoreProperties
cas.authn.oauth.core.user-profile-view-typeUser profile view type determines how the final user profile should be rendered once an access token is "validated".
NESTED
User profile view type determines how the final user profile should be rendered once an access token is "validated". Available values are as follows:
  • NESTED: Return and render the user profile view in nested mode. This is the default option, most usually.
  • FLAT: Return and render the user profile view in flattened mode where all attributes are flattened down to one level only.
Type
OAuthCoreProperties.UserProfileViewTypes
Default
NESTED
Defined by
OAuthCoreProperties
cas.authn.oauth.crypto.algThe signing/encryption algorithm to use.
no default

The signing/encryption algorithm to use.

Type
String
Default
none
Defined by
EncryptionOptionalSigningOptionalJwtCryptographyProperties
cas.authn.oauth.crypto.enabledWhether crypto operations are enabled.
true

Whether crypto operations are enabled.

Type
Boolean
Default
true
Defined by
EncryptionOptionalSigningOptionalJwtCryptographyProperties
cas.authn.oauth.crypto.encryption-enabledWhether crypto encryption operations are enabled.
true

Whether crypto encryption operations are enabled.

Type
Boolean
Default
true
Defined by
EncryptionOptionalSigningOptionalJwtCryptographyProperties
cas.authn.oauth.crypto.encryption.key-sizeThe encryption key size.
512

The encryption key size.

Type
Integer
Default
512
Defined by
EncryptionJwtCryptoProperties
cas.authn.oauth.crypto.signing-enabledWhether crypto signing operations are enabled.
true

Whether crypto signing operations are enabled.

Type
Boolean
Default
true
Defined by
EncryptionOptionalSigningOptionalJwtCryptographyProperties
cas.authn.oauth.crypto.signing.key-sizeThe signing key size.
512

The signing key size.

Type
Integer
Default
512
Defined by
SigningJwtCryptoProperties
cas.authn.oauth.crypto.strategy-typeControl the cipher sequence of operations.
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.
Type
String
Default
ENCRYPT_AND_SIGN
Defined by
EncryptionOptionalSigningOptionalJwtCryptographyProperties
cas.authn.oauth.csrf-cookie.domainCookie domain.
no default

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.

Type
String
Default
none
Defined by
OAuthCsrfCookieProperties
cas.authn.oauth.csrf-cookie.http-onlytrue if this cookie contains the HttpOnly attribute.
true

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

Type
Boolean
Default
true
Defined by
OAuthCsrfCookieProperties
cas.authn.oauth.csrf-cookie.max-ageThe maximum age of the cookie, specified in seconds.
-1
Duration

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.

Type
String
Default
-1
Defined by
OAuthCsrfCookieProperties
cas.authn.oauth.csrf-cookie.nameCookie name.
no default

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.

Type
String
Default
none
Defined by
OAuthCsrfCookieProperties
cas.authn.oauth.csrf-cookie.pathCookie path.
no default

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.

Type
String
Default
none
Defined by
OAuthCsrfCookieProperties
cas.authn.oauth.csrf-cookie.same-site-policyIf 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.
no default

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
Type
String
Default
none
Defined by
OAuthCsrfCookieProperties
cas.authn.oauth.csrf-cookie.secureTrue if sending this cookie should be restricted to a secure protocol, or false if the it can be sent using any protocol.
true

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

Type
Boolean
Default
true
Defined by
OAuthCsrfCookieProperties
cas.authn.oauth.device-token.max-time-to-live-in-secondsHard timeout to kill the device token and expire it.
PT5M
Duration

Hard timeout to kill the device token and expire it.

Type
String
Default
PT5M
Defined by
OAuthDeviceTokenProperties
cas.authn.oauth.device-token.refresh-intervalThe device refresh interval.
PT15S
Duration

The device refresh interval. The client should attempt to acquire an access token every few seconds (at a rate specified by interval) by POSTing to the access token endpoint on the server.

Type
String
Default
PT15S
Defined by
OAuthDeviceTokenProperties
cas.authn.oauth.device-token.storage-nameThe storage object name used and created by CAS to hold OAuth device tokens in the backing ticket registry implementation.
oauthDeviceTokensCache

The storage object name used and created by CAS to hold OAuth device tokens in the backing ticket registry implementation.

Type
String
Default
oauthDeviceTokensCache
Defined by
OAuthDeviceTokenProperties
cas.authn.oauth.device-user-code.max-time-to-live-in-secondsHard timeout to kill the token and expire it.
PT1M
Duration

Hard timeout to kill the token and expire it.

Type
String
Default
PT1M
Defined by
OAuthDeviceUserCodeProperties
cas.authn.oauth.device-user-code.storage-nameThe storage object name used and created by CAS to hold OAuth device user codes in the backing ticket registry implementation.
oauthDeviceUserCodesCache

The storage object name used and created by CAS to hold OAuth device user codes in the backing ticket registry implementation.

Type
String
Default
oauthDeviceUserCodesCache
Defined by
OAuthDeviceUserCodeProperties
cas.authn.oauth.device-user-code.user-code-lengthLength of the generated user code.
8

Length of the generated user code.

Type
Integer
Default
8
Defined by
OAuthDeviceUserCodeProperties
cas.authn.oauth.grants.resource-owner.require-service-headerWhether using the resource-owner grant should enforce authorization rules and per-service policies based on a service parameter is provided as a header outside the normal semantics of the grant and protocol.
false

Whether using the resource-owner grant should enforce authorization rules and per-service policies based on a service parameter is provided as a header outside the normal semantics of the grant and protocol.

Type
Boolean
Default
false
Defined by
ResourceOwner
cas.authn.oauth.refresh-token.create-as-jwtCreate access token as JWTs.
false

Create access token as JWTs.

Type
Boolean
Default
false
Defined by
OAuthRefreshTokenProperties
cas.authn.oauth.refresh-token.max-active-tokens-allowedMaximum number of active refresh tokens that an application can receive.
0

Maximum number of active refresh tokens that an application can receive. If the application requests more that this limit, the request will be denied and the access token will not be issued.

Type
Long
Default
0
Defined by
OAuthRefreshTokenProperties
cas.authn.oauth.refresh-token.storage-nameThe storage object name used and created by CAS to hold OAuth refresh tokens in the backing ticket registry implementation.
oauthRefreshTokensCache

The storage object name used and created by CAS to hold OAuth refresh tokens in the backing ticket registry implementation.

Type
String
Default
oauthRefreshTokensCache
Defined by
OAuthRefreshTokenProperties
cas.authn.oauth.refresh-token.time-to-kill-in-secondsHard timeout beyond which the refresh token is considered expired.
P14D
Duration

Hard timeout beyond which the refresh token is considered expired.

Type
String
Default
P14D
Defined by
OAuthRefreshTokenProperties
cas.authn.oauth.refresh-token.track-access-tokensIf true, the refresh token will keep track of the access tokens issued using it.
true

If true, the refresh token will keep track of the access tokens issued using it. The access tokens will remain attached to the refresh token as long as the refresh token is valid and they are not periodically on on-demand checked for validity or removed from the refresh token if they expire. The tracking mechanism is only for history and auditing purposes.

Type
Boolean
Default
true
Defined by
OAuthRefreshTokenProperties
cas.authn.oauth.session-replication.cookie.allowed-ip-addresses-patternA regular expression pattern that indicates the set of allowed IP addresses, when #isPinToSession() is configured.
no default
Regex

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.

Type
String
Default
none
Defined by
CookieSessionReplicationProperties
cas.authn.oauth.session-replication.cookie.auto-configure-cookie-pathDecide if cookie paths should be automatically configured based on the application context path, when the cookie path is not configured.
true

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

Type
Boolean
Default
true
Defined by
CookieSessionReplicationProperties
cas.authn.oauth.session-replication.cookie.crypto.algThe signing/encryption algorithm to use.
no default

The signing/encryption algorithm to use.

Type
String
Default
none
Defined by
EncryptionJwtSigningJwtCryptographyProperties
cas.authn.oauth.session-replication.cookie.crypto.enabledWhether crypto operations are enabled.
true

Whether crypto operations are enabled.

Type
Boolean
Default
true
Defined by
EncryptionJwtSigningJwtCryptographyProperties
cas.authn.oauth.session-replication.cookie.crypto.encryption.key-sizeThe encryption key size.
512

The encryption key size.

Type
Integer
Default
512
Defined by
EncryptionJwtCryptoProperties
cas.authn.oauth.session-replication.cookie.crypto.signing.key-sizeThe signing key size.
512

The signing key size.

Type
Integer
Default
512
Defined by
SigningJwtCryptoProperties
cas.authn.oauth.session-replication.cookie.crypto.strategy-typeControl the cipher sequence of operations.
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.
Type
String
Default
ENCRYPT_AND_SIGN
Defined by
EncryptionJwtSigningJwtCryptographyProperties
cas.authn.oauth.session-replication.cookie.domainCookie domain.
no default

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.

Type
String
Default
none
Defined by
CookieSessionReplicationProperties
cas.authn.oauth.session-replication.cookie.geo-locate-client-sessionWhen 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.
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.

Type
Boolean
Default
false
Defined by
CookieSessionReplicationProperties
cas.authn.oauth.session-replication.cookie.http-onlytrue if this cookie contains the HttpOnly attribute.
true

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

Type
Boolean
Default
true
Defined by
CookieSessionReplicationProperties
cas.authn.oauth.session-replication.cookie.max-ageThe maximum age of the cookie, specified in seconds.
-1
Duration

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.

Type
String
Default
-1
Defined by
CookieSessionReplicationProperties
cas.authn.oauth.session-replication.cookie.nameCookie name.
no default

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.

Type
String
Default
none
Defined by
CookieSessionReplicationProperties
cas.authn.oauth.session-replication.cookie.pathCookie path.
no default

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.

Type
String
Default
none
Defined by
CookieSessionReplicationProperties
cas.authn.oauth.session-replication.cookie.pin-to-sessionWhen 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.
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.

Turning off session pinning is not exactly ideal. This is a barrier to prevent cookie replay attacks. A cookie that was created with an IP given a certain location cannot be replayed back in a different browser with a different IP from a different location.

There may however be legitimate reasons to turn it off and relax this after careful reviews, if you intend to support a type of user who intends to switch their IP quite frequently. A classic example is the type of user that is on VPN at the time of login, but decides to resume their work a few hours later off VPN or at a different location.

Type
Boolean
Default
true
Defined by
CookieSessionReplicationProperties
cas.authn.oauth.session-replication.cookie.same-site-policyIf 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.
no default

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
Type
String
Default
none
Defined by
CookieSessionReplicationProperties
cas.authn.oauth.session-replication.cookie.secureTrue if sending this cookie should be restricted to a secure protocol, or false if the it can be sent using any protocol.
true

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

Type
Boolean
Default
true
Defined by
CookieSessionReplicationProperties
cas.authn.oauth.session-replication.replicate-sessionsIndicates whether profiles and other session data, collected as part of authentication flows and protocol requests that are kept by the container session, should be replicated across the cluster using CAS and its own...
false

Indicates whether profiles and other session data, collected as part of authentication flows and protocol requests that are kept by the container session, should be replicated across the cluster using CAS and its own ticket registry. Without this option, profile data and other related pieces of information should be manually replicated via means and libraries outside of CAS. @deprecated since 7.3.0

Type
Boolean
Default
false
Defined by
SessionReplicationProperties
cas.authn.oauth.uma.permission-ticket.max-time-to-live-in-secondsHard timeout to kill the UMA permission token and expire it.
PT3M
Duration

Hard timeout to kill the UMA permission token and expire it.

Type
String
Default
PT3M
Defined by
UmaPermissionTicketProperties
cas.authn.oauth.uma.requesting-party-token.max-time-to-live-in-secondsHard timeout to kill the RP token and expire it.
PT3M
Duration

Hard timeout to kill the RP token and expire it.

Type
String
Default
PT3M
Defined by
UmaRequestingPartyTokenProperties
cas.authn.oauth.uma.resource-set.jpa.autocommitThe default auto-commit behavior of connections in the pool.
false

The default auto-commit behavior of connections in the pool. Determined whether queries such as update/insert should be immediately executed without waiting for an underlying transaction.

Type
Boolean
Default
false
Defined by
UmaResourceSetJpaProperties
cas.authn.oauth.uma.resource-set.jpa.batch-sizeA non-zero value enables use of JDBC2 batch updates by Hibernate. e.g. recommended values between 5 and 30.
100

A non-zero value enables use of JDBC2 batch updates by Hibernate. e.g. recommended values between 5 and 30.

Type
Integer
Default
100
Defined by
UmaResourceSetJpaProperties
cas.authn.oauth.uma.resource-set.jpa.connection-timeoutIndicates the maximum number of milliseconds that the service can wait to obtain a connection.
PT30S
Duration

Indicates the maximum number of milliseconds that the service can wait to obtain a connection.

Type
String
Default
PT30S
Defined by
UmaResourceSetJpaProperties
cas.authn.oauth.uma.resource-set.jpa.data-source-nameAttempts to do a JNDI data source look up for the data source name specified.
no default

Attempts to do a JNDI data source look up for the data source name specified. Will attempt to locate the data source object as is.

Type
String
Default
none
Defined by
UmaResourceSetJpaProperties
cas.authn.oauth.uma.resource-set.jpa.ddl-autoHibernate feature to automatically validate and exports DDL to the schema.
update
Hibernate feature to automatically validate and exports DDL to the schema. By default, creates and drops the schema automatically when a session is starts and ends. Setting the value to validate or none may be more desirable for production, but any of the following options can be used:
  • validate: Validate the schema, but make no changes to the database.
  • update: Update the schema.
  • create: Create the schema, destroying previous data.
  • create-drop: Drop the schema at the end of the session.
  • none: Do nothing.

Note that during a version migration where any schema has changed create-drop will result in the loss of all data as soon as CAS is started. For transient data like tickets this is probably not an issue, but in cases like the audit table important data could be lost. Using `update`, while safe for data, is confirmed to result in invalid database state. validate or none settings are likely the only safe options for production use.

For more info, see this.

Type
String
Default
update
Defined by
UmaResourceSetJpaProperties
cas.authn.oauth.uma.resource-set.jpa.default-catalogQualifies unqualified table names with the given catalog in generated SQL.
no default

Qualifies unqualified table names with the given catalog in generated SQL.

Type
String
Default
none
Defined by
UmaResourceSetJpaProperties
cas.authn.oauth.uma.resource-set.jpa.default-schemaQualify unqualified table names with the given schema/tablespace in generated SQL.
no default

Qualify unqualified table names with the given schema/tablespace in generated SQL.

Type
String
Default
none
Defined by
UmaResourceSetJpaProperties
cas.authn.oauth.uma.resource-set.jpa.dialectThe database dialect is a configuration setting for platform independent software (JPA, Hibernate, etc) which allows such software to translate its generic SQL statements into vendor specific DDL, DML.
org.hibernate.dialect.HSQLDialect

The database dialect is a configuration setting for platform independent software (JPA, Hibernate, etc) which allows such software to translate its generic SQL statements into vendor specific DDL, DML.

Type
String
Default
org.hibernate.dialect.HSQLDialect
Defined by
UmaResourceSetJpaProperties
cas.authn.oauth.uma.resource-set.jpa.fail-fast-timeoutSet the pool initialization failure timeout.
1
Set the pool initialization failure timeout.
  • Any value greater than zero will be treated as a timeout for pool initialization. The calling thread will be blocked from continuing until a successful connection to the database, or until the timeout is reached. If the timeout is reached, then a PoolInitializationException will be thrown.
  • A value of zero will not prevent the pool from starting in the case that a connection cannot be obtained. However, upon start the pool will attempt to obtain a connection and validate that the connectionTestQuery and connectionInitSql are valid. If those validations fail, an exception will be thrown. If a connection cannot be obtained, the validation is skipped and the pool will start and continue to try to obtain connections in the background. This can mean that callers to DataSource#getConnection() may encounter exceptions.
  • A value less than zero will not bypass any connection attempt and validation during startup, and therefore the pool will start immediately. The pool will continue to try to obtain connections in the background. This can mean that callers to DataSource#getConnection() may encounter exceptions.
Note that if this timeout value is greater than or equal to zero (0), and therefore an initial connection validation is performed, this timeout does not override the connectionTimeout or validationTimeout; they will be honored before this timeout is applied. The default value is one millisecond.
Type
Long
Default
1
Defined by
UmaResourceSetJpaProperties
cas.authn.oauth.uma.resource-set.jpa.fetch-sizeUsed to specify number of rows to be fetched in a select query.
100

Used to specify number of rows to be fetched in a select query.

Type
Integer
Default
100
Defined by
UmaResourceSetJpaProperties
cas.authn.oauth.uma.resource-set.jpa.generate-statisticsAllow hibernate to generate query statistics.
false

Allow hibernate to generate query statistics.

Type
Boolean
Default
false
Defined by
UmaResourceSetJpaProperties
cas.authn.oauth.uma.resource-set.jpa.health-queryThe SQL query to be executed to test the validity of connections.
no default

The SQL query to be executed to test the validity of connections. This is for "legacy" databases that do not support the JDBC4 Connection.isValid() API.

Type
String
Default
none
Defined by
UmaResourceSetJpaProperties
cas.authn.oauth.uma.resource-set.jpa.idle-timeoutControls the maximum amount of time that a connection is allowed to sit idle in the pool.
PT10M
Duration

Controls the maximum amount of time that a connection is allowed to sit idle in the pool.

Type
String
Default
PT10M
Defined by
UmaResourceSetJpaProperties
cas.authn.oauth.uma.resource-set.jpa.isolate-internal-queriesThis property determines whether data source isolates internal pool queries, such as the connection alive test, in their own transaction.
false

This property determines whether data source isolates internal pool queries, such as the connection alive test, in their own transaction.

Since these are typically read-only queries, it is rarely necessary to encapsulate them in their own transaction. This property only applies if #autocommit is disabled.

Type
Boolean
Default
false
Defined by
UmaResourceSetJpaProperties
cas.authn.oauth.uma.resource-set.jpa.isolation-level-nameDefines the isolation level for transactions.
ISOLATION_READ_COMMITTED

Defines the isolation level for transactions. @see org.springframework.transaction.TransactionDefinition

Type
String
Default
ISOLATION_READ_COMMITTED
Defined by
UmaResourceSetJpaProperties
cas.authn.oauth.uma.resource-set.jpa.leak-thresholdControls the amount of time that a connection can be out of the pool before a message is logged indicating a possible connection leak.
PT6S
Duration

Controls the amount of time that a connection can be out of the pool before a message is logged indicating a possible connection leak.

Type
String
Default
PT6S
Defined by
UmaResourceSetJpaProperties
cas.authn.oauth.uma.resource-set.jpa.physical-naming-strategy-class-nameFully-qualified name of the class that can control the physical naming strategy of hibernate.
org.apereo.cas.hibernate.CasHibernatePhysicalNamingStrategy

Fully-qualified name of the class that can control the physical naming strategy of hibernate.

Type
String
Default
org.apereo.cas.hibernate.CasHibernatePhysicalNamingStrategy
Defined by
UmaResourceSetJpaProperties
cas.authn.oauth.uma.resource-set.jpa.pool.keep-alive-timeThis property controls the keepalive interval for a connection in the pool.
0
Duration

This property controls the keepalive interval for a connection in the pool. An in-use connection will never be tested by the keepalive thread, only when it is idle will it be tested. Default is zero, which disables this feature.

Type
String
Default
0
Defined by
ConnectionPoolingProperties
cas.authn.oauth.uma.resource-set.jpa.pool.max-sizeControls the maximum number of connections to keep in the pool, including both idle and in-use connections.
18

Controls the maximum number of connections to keep in the pool, including both idle and in-use connections.

Type
Integer
Default
18
Defined by
ConnectionPoolingProperties
cas.authn.oauth.uma.resource-set.jpa.pool.max-waitSets the maximum time in seconds that this data source will wait while attempting to connect to a database.
PT2S
Duration

Sets the maximum time in seconds that this data source will wait while attempting to connect to a database.

A value of zero specifies that the timeout is the default system timeout if there is one; otherwise, it specifies that there is no timeout.

Type
String
Default
PT2S
Defined by
ConnectionPoolingProperties
cas.authn.oauth.uma.resource-set.jpa.pool.maximum-lifetimeThis property controls the maximum lifetime of a connection in the pool.
PT10M
Duration

This property controls the maximum lifetime of a connection in the pool. When a connection reaches this timeout, even if recently used, it will be retired from the pool. An in-use connection will never be retired, only when it is idle will it be removed.

Type
String
Default
PT10M
Defined by
ConnectionPoolingProperties
cas.authn.oauth.uma.resource-set.jpa.pool.min-sizeControls the minimum size that the pool is allowed to reach, including both idle and in-use connections.
6

Controls the minimum size that the pool is allowed to reach, including both idle and in-use connections.

Type
Integer
Default
6
Defined by
ConnectionPoolingProperties
cas.authn.oauth.uma.resource-set.jpa.pool.nameSet the name of the connection pool.
no default

Set the name of the connection pool. This is primarily used for the MBean to uniquely identify the pool configuration.

Type
String
Default
none
Defined by
ConnectionPoolingProperties
cas.authn.oauth.uma.resource-set.jpa.pool.suspensionWhether or not pool suspension is allowed.
false

Whether or not pool suspension is allowed.

There is a performance impact when pool suspension is enabled. Unless you need it (for a redundancy system for example) do not enable it.

Type
Boolean
Default
false
Defined by
ConnectionPoolingProperties
cas.authn.oauth.uma.resource-set.jpa.pool.timeout-millisThe maximum number of milliseconds that the pool will wait for a connection to be validated as alive.
1000

The maximum number of milliseconds that the pool will wait for a connection to be validated as alive.

Type
Long
Default
1000
Defined by
ConnectionPoolingProperties
cas.authn.oauth.uma.resource-set.jpa.propagation-behavior-nameDefines the propagation behavior for transactions.
PROPAGATION_REQUIRED

Defines the propagation behavior for transactions. @see org.springframework.transaction.TransactionDefinition

Type
String
Default
PROPAGATION_REQUIRED
Defined by
UmaResourceSetJpaProperties
cas.authn.oauth.uma.resource-set.jpa.propertiesAdditional settings provided by Hibernate (or the connection provider) in form of key-value pairs.
no default

Additional settings provided by Hibernate (or the connection provider) in form of key-value pairs.

Type
Map<String,String>
Default
none
Defined by
UmaResourceSetJpaProperties
cas.authn.oauth.uma.resource-set.jpa.read-onlyConfigures the Connections to be added to the pool as read-only Connections.
false

Configures the Connections to be added to the pool as read-only Connections.

Type
Boolean
Default
false
Defined by
UmaResourceSetJpaProperties

Required settings may be needed to activate or affect the feature; review them even when they have a default. Optional settings only need to be set to change a default or to turn on the behavior they control. Third party settings belong to libraries such as Spring Boot that CAS builds on; their own documentation may have more detail.

Signing & encryption

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:



1
2



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:



1
2
3
4
5



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

Hibernate & JDBC

Control global properties that are relevant to Hibernate, when CAS attempts to employ and utilize database resources, connections and queries.

cas.jdbc.gen-ddlWhether to generate DDL after the EntityManagerFactory has been initialized creating/updating all relevant tables.
true

Whether to generate DDL after the EntityManagerFactory has been initialized creating/updating all relevant tables.

Type
Boolean
Default
true
Defined by
DatabaseProperties
cas.jdbc.physical-table-namesIndicate a physical table name to be used by the hibernate naming strategy in case table names need to be customized for the specific type of database.
no default

Indicate a physical table name to be used by the hibernate naming strategy in case table names need to be customized for the specific type of database. The key here indicates the CAS-provided table name and the value is the translate physical name for the database. If a match is not found for the CAS-provided table name, then that name will be used by default.

Type
Map<String,String>
Default
none
Defined by
DatabaseProperties
cas.jdbc.show-sqlWhether SQL queries should be displayed in the console/logs.
false

Whether SQL queries should be displayed in the console/logs.

Type
Boolean
Default
false
Defined by
DatabaseProperties
Notes on configuration

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