Google OpenID Connect
For an overview of the delegated authentication flow, please see this guide.
Support is enabled by including the following dependency in the WAR overlay:
1
2
3
4
5
<dependency>
<groupId>org.apereo.cas</groupId>
<artifactId>cas-server-support-pac4j-oidc</artifactId>
<version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-support-pac4j-oidc:${project.'cas.version'}"
1
2
3
4
5
6
7
8
9
dependencyManagement {
imports {
mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
}
}
dependencies {
implementation "org.apereo.cas:cas-server-support-pac4j-oidc"
}
1
2
3
4
5
6
7
8
9
10
dependencies {
/*
The following platform references are included automatically and are listed for reference only.
implementation enforcedPlatform("org.apereo.cas:cas-server-support-bom:${project.'cas.version'}")
implementation platform(org.springframework.boot.gradle.plugin.SpringBootPlugin.BOM_COORDINATES)
*/
implementation "org.apereo.cas:cas-server-support-pac4j-oidc"
}
Configuration
The following settings and properties are available from the CAS configuration catalog:
cas.authn.pac4j.oidc[0].google.discovery-uriThe discovery endpoint to locate the provider metadata.
The discovery endpoint to locate the provider metadata.
cas.authn.pac4j.oidc[0].google.federation.jwks.locationSpecific JWKS for the federation.
Specific JWKS for the federation. 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.
cas.authn.pac4j.oidc[0].google.idThe client id.
The client id.
cas.authn.pac4j.oidc[0].google.private-key-jwt.jwks.locationSpecific JWKS for the private_key_jwt client authentication method.
Specific JWKS for the private_key_jwt client authentication method. 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.
cas.authn.pac4j.oidc[0].google.secretThe client secret.
The client secret.
cas.authn.pac4j.oidc[0].google.allow-unsigned-id-tokensWhether unsigned id tokens issued as plain JWTs are accepted.
Whether unsigned id tokens issued as plain JWTs are accepted.
cas.authn.pac4j.oidc[0].google.auto-redirect-typeAuto-redirect to this client.
NONE-
SERVER: Redirect on the server side, typically making CAS invisible. -
CLIENT: Redirect on the client side using browser redirects, etc. -
NONE: Do nothing and let the selection take place manually.
cas.authn.pac4j.oidc[0].google.callback-urlCallback URL to use to return the flow back to the CAS server one the identity provider is successfully done.
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.oidc[0].google.callback-url-typeDetermine how the callback url should be resolved.
QUERY_PARAMETERCallbackUrlTypes#QUERY_PARAMETER. Available values are as follows: -
PATH_PARAMETER: Path parameter callback url. The client name is added to the path of the callback URL. -
QUERY_PARAMETER: Query parameter callback url. The client name is added to the path of a query parameter. -
NONE: No callback url. No name is added to the callback URL to be able to distinguish the client.
cas.authn.pac4j.oidc[0].google.client-authentication-methodThe preferred client authentication method that will be chosen for token requests.
The preferred client authentication method that will be chosen for token requests. If none is specified, one will be chosen somewhat randomly based on what the OIDC OP supports.
cas.authn.pac4j.oidc[0].google.client-nameName of the client mostly for UI purposes and uniqueness.
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.oidc[0].google.connect-timeoutRead timeout of the OIDC client.
Read timeout of the OIDC client.
cas.authn.pac4j.oidc[0].google.css-classCSS class that should be assigned to this client.
CSS class that should be assigned to this client.
cas.authn.pac4j.oidc[0].google.custom-paramsCustom parameters to send along in authZ requests, etc.
Custom parameters to send along in authZ requests, etc.
cas.authn.pac4j.oidc[0].google.disable-pkceDisable PKCE support for the provider.
Disable PKCE support for the provider.
cas.authn.pac4j.oidc[0].google.display-nameIndicate the title or display name of the client for decoration and client presentation purposes.
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.oidc[0].google.enabledWhether the client/external identity provider should be considered active and enabled for integration purposes.
trueWhether the client/external identity provider should be considered active and enabled for integration purposes.
cas.authn.pac4j.oidc[0].google.expire-session-with-tokenChecks if sessions expire with token expiration.
Checks if sessions expire with token expiration.
cas.authn.pac4j.oidc[0].google.federation.application-typeApplication type for the RP (client) entity statement.
webApplication type for the RP (client) entity statement.
cas.authn.pac4j.oidc[0].google.federation.client-registration-typesRegistration types for the RP (client) entity statement.
explicit,automaticRegistration types for the RP (client) entity statement.
cas.authn.pac4j.oidc[0].google.federation.contact-emailsThe contact emails for this client.
The contact emails for this client.
cas.authn.pac4j.oidc[0].google.federation.contact-nameThe contact name for this client.
The contact name for this client.
cas.authn.pac4j.oidc[0].google.federation.enabledWhether the federation is enabled.
Whether the federation is enabled.
cas.authn.pac4j.oidc[0].google.federation.grant-typesGrant types for the RP (client) entity statement.
authorization_codeGrant types for the RP (client) entity statement.
cas.authn.pac4j.oidc[0].google.federation.jwks.kidThe key identifier.
The key identifier.
cas.authn.pac4j.oidc[0].google.federation.response-typesResponse types for the RP (client) entity statement.
codeResponse types for the RP (client) entity statement.
cas.authn.pac4j.oidc[0].google.federation.scopesScopes for the RP (client) entity statement.
openid,email,profileScopes for the RP (client) entity statement.
cas.authn.pac4j.oidc[0].google.federation.target-opThe target OIDC provider in federation.
The target OIDC provider in federation.
cas.authn.pac4j.oidc[0].google.federation.trust-anchorsThe trust anchors to use for federation.
The trust anchors to use for federation. This is defined as a map; the key is the trust anchor issuer and the value is the JWKS URL of the trust anchor.
cas.authn.pac4j.oidc[0].google.federation.validity-in-daysValidity in days of the RP (client) entity statement.
90Validity in days of the RP (client) entity statement.
cas.authn.pac4j.oidc[0].google.include-access-token-claimsIf enabled, try to process the access token as a JWT and include its claims in the profile.
If enabled, try to process the access token as a JWT and include its claims in the profile. Only enable this if there is an agreement between the IdP and CAS about the format of the access token. If not, the token format could change at any time.
cas.authn.pac4j.oidc[0].google.logout-urlLogout url used for this provider.
Logout url used for this provider.
cas.authn.pac4j.oidc[0].google.mapped-claimsList arbitrary mappings of claims when fetching user profiles.
List arbitrary mappings of claims when fetching user profiles. Uses a "directed list" where the allowed syntax would be claim->attribute.
cas.authn.pac4j.oidc[0].google.max-clock-skewClock skew in order to account for drift, when validating id tokens.
Clock skew in order to account for drift, when validating id tokens.
cas.authn.pac4j.oidc[0].google.preferred-jws-algorithmThe JWS algorithm to use forcefully when validating ID tokens.
The JWS algorithm to use forcefully when validating ID tokens. If none is defined, the first algorithm from metadata will be used.
cas.authn.pac4j.oidc[0].google.principal-id-attributeThe attribute found in the identity provider response that may be used to establish the authenticated user and build a profile for CAS.
The attribute found in the identity provider response that may be used to establish the authenticated user and build a profile for CAS.
cas.authn.pac4j.oidc[0].google.private-key-jwt.jwks.kidThe key identifier.
The key identifier.
cas.authn.pac4j.oidc[0].google.propagate-logoutIndicate whether the logout should be propagated from the CAS server to the delegated identity server.
trueIndicate whether the logout should be propagated from the CAS server to the delegated identity server.
cas.authn.pac4j.oidc[0].google.read-timeoutConnect timeout of the OIDC client.
Connect timeout of the OIDC client.
cas.authn.pac4j.oidc[0].google.response-modeThe response mode specifies how the result of the authorization request is formatted.
The response mode specifies how the result of the authorization request is formatted. For backward compatibility the default value is empty, which means the default pac4j (empty) response mode is used. Possible values includes "query", "fragment", "form_post", or "web_message"
cas.authn.pac4j.oidc[0].google.response-typeThe response type tells the authorization server which grant to execute.
The response type tells the authorization server which grant to execute. For backward compatibility the default value is empty, which means the default pac4j ("code") response type is used. Possibles values includes "code", "token" or "id_token".
cas.authn.pac4j.oidc[0].google.scopeRequested scope(s).
Requested scope(s).
cas.authn.pac4j.oidc[0].google.supported-client-authentication-methodsControl the list of supported client authentication methods that can be accepted and understood by this integration.
Control the list of supported client authentication methods that can be accepted and understood by this integration. Multiple methods may be specified and separated via a comma. Example might be client_secret_basic,client_secret_post,client_secret_jwt.
cas.authn.pac4j.oidc[0].google.token-expiration-advanceDefault time period advance (in seconds) for considering an access token expired.
Default time period advance (in seconds) for considering an access token expired.
cas.authn.pac4j.oidc[0].google.use-nonceWhether an initial nonce should be to used initially for replay attack mitigation.
Whether an initial nonce should be to used initially for replay attack mitigation.
cas.authn.pac4j.oidc[0].google.validate-logout-tokenControls whether the logout token submitted as a JWT should be validated for the correct signature, etc.
Controls whether the logout token submitted as a JWT should be validated for the correct signature, etc.
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.
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.
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.