OAuth20
For an overview of the delegated authentication flow, please see this guide.
The following settings and properties are available from the CAS configuration catalog:
cas.authn.pac4j.oauth2[0].auth-url=
Authorization endpoint of the provider.
|
cas.authn.pac4j.oauth2[0].id=
The client id.
|
cas.authn.pac4j.oauth2[0].profile-url=
Profile endpoint of the provider.
|
cas.authn.pac4j.oauth2[0].secret=
The client secret.
|
cas.authn.pac4j.oauth2[0].token-url=
Token endpoint of the provider.
|
cas.authn.pac4j.oauth2=
Settings that deal with having OAuth2-capable providers as an external delegated-to authentication provider.
|
cas.authn.pac4j.oauth2[0].auto-redirect-type=NONE
Auto-redirect to this client.
|
cas.authn.pac4j.oauth2[0].callback-url=
Callback URL to use to return the flow back to the CAS server one the identity provider is successfully done. This may be used at the discretion of the client and its type to build service parameters, redirect URIs, etc. If none is specified, the CAS server's login endpoint will be used as the basis of the final callback url.
|
cas.authn.pac4j.oauth2[0].callback-url-type=QUERY_PARAMETER
Determine how the callback url should be resolved.
Default is
|
cas.authn.pac4j.oauth2[0].client-authentication-method=
The client authentication method: basicAuth (default) or requestBody.
|
cas.authn.pac4j.oauth2[0].client-name=
Name of the client mostly for UI purposes and uniqueness. This name, with 'non-word' characters converted to '-' (e.g. "This Org (New)" becomes "This-Org--New-") is added to the "class" attribute of the redirect link on the login page, to allow for custom styling of individual IdPs (e.g. for an organization logo).
|
cas.authn.pac4j.oauth2[0].css-class=
CSS class that should be assigned to this client.
|
cas.authn.pac4j.oauth2[0].custom-params=
Custom parameters in form of key-value pairs sent along in authZ requests, etc.
|
cas.authn.pac4j.oauth2[0].display-name=
Indicate the title or display name of the client for decoration and client presentation purposes. If left blank, the client original name would be used by default.
|
cas.authn.pac4j.oauth2[0].enabled=true
Whether the client/external identity provider should be considered active and enabled for integration purposes.
|
cas.authn.pac4j.oauth2[0].principal-attribute-id=
The attribute to use as the principal identifier built during and upon a successful authentication attempt.
|
cas.authn.pac4j.oauth2[0].profile-attrs=
Profile attributes to request and collect in form of key-value pairs.
Key is the attribute name, and value is the mapped attribute name, if necessary.
If remapping is not required, key and value should match.
It's also possible to define values as
|
cas.authn.pac4j.oauth2[0].profile-path=
Profile path portion of the profile endpoint of the provider.
|
cas.authn.pac4j.oauth2[0].profile-verb=POST
Http method to use when asking for profile.
|
cas.authn.pac4j.oauth2[0].response-type=code
Response type determines the authentication flow on the Authentication Server.
|
cas.authn.pac4j.oauth2[0].scope=
The scope requested from the identity provider.
|
cas.authn.pac4j.oauth2[0].with-state=
Whether a state value should be generated when sending authentication requests to the provider.
|
Configuration Metadata
The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.
Be Selective
This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.
YAGNI
Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.
Naming Convention
Property names can be specified in very relaxed terms. For instance cas.someProperty
, cas.some-property
, cas.some_property
are all valid names. While all
forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where
this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those
that might be presented to the system via an external library or framework such as Spring Boot, etc.
When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value
.
The only possible exception to this rule is when naming actuator endpoints; The name of the
actuator endpoints (i.e. ssoSessions
) MUST remain in camelCase mode.
Settings and properties that are controlled by the CAS platform directly always begin with the prefix cas
. All other settings are controlled and provided
to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with
the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition
or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the
way you intend.
Validation
Configuration properties are automatically validated on CAS startup to report issues with configuration binding, specially if defined CAS settings cannot be
recognized or validated by the configuration schema. The validation process is on by default and can be skipped on startup using a special system
property SKIP_CONFIG_VALIDATION
that should be set to true
. Additional validation processes are also handled
via Configuration Metadata and property migrations applied automatically on
startup by Spring Boot and family.
Indexed Settings
CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value
. The index [0]
is meant to be
incremented by the adopter to allow for distinct multiple configuration blocks.