Azure Active Directory

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].azure.discovery-uriThe discovery endpoint to locate the provider metadata.
no default
Required

The discovery endpoint to locate the provider metadata.

Type
String
Default
none
Defined by
Pac4jAzureOidcClientProperties
cas.authn.pac4j.oidc[0].azure.federation.jwks.locationSpecific JWKS for the federation.
no default
Required

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.

Type
Resource
Default
none
Defined by
Pac4jOidcClientJwksProperties
cas.authn.pac4j.oidc[0].azure.idThe client id.
no default
RequiredSpEL

The client id.

Type
String
Default
none
Defined by
Pac4jAzureOidcClientProperties
Supports
Spring Expression Language
cas.authn.pac4j.oidc[0].azure.private-key-jwt.jwks.locationSpecific JWKS for the private_key_jwt client authentication method.
no default
Required

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.

Type
Resource
Default
none
Defined by
Pac4jOidcClientJwksProperties
cas.authn.pac4j.oidc[0].azure.secretThe client secret.
no default
RequiredSpEL

The client secret.

Type
String
Default
none
Defined by
Pac4jAzureOidcClientProperties
Supports
Spring Expression Language
cas.authn.pac4j.oidc[0].azure.allow-unsigned-id-tokensWhether unsigned id tokens issued as plain JWTs are accepted.
no default

Whether unsigned id tokens issued as plain JWTs are accepted.

Type
boolean
Default
none
Defined by
Pac4jAzureOidcClientProperties
cas.authn.pac4j.oidc[0].azure.auto-redirect-typeAuto-redirect to this client.
NONE
Auto-redirect to this client. Available values are as follows:
  • 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.
Type
DelegationAutoRedirectTypes
Default
NONE
Defined by
Pac4jAzureOidcClientProperties
cas.authn.pac4j.oidc[0].azure.callback-urlCallback URL to use to return the flow back to the CAS server one the identity provider is successfully done.
no default

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.

Type
String
Default
none
Defined by
Pac4jAzureOidcClientProperties
cas.authn.pac4j.oidc[0].azure.callback-url-typeDetermine how the callback url should be resolved.
QUERY_PARAMETER
Determine how the callback url should be resolved. Default is CallbackUrlTypes#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.
Type
Pac4jBaseClientProperties.CallbackUrlTypes
Default
QUERY_PARAMETER
Defined by
Pac4jAzureOidcClientProperties
cas.authn.pac4j.oidc[0].azure.client-authentication-methodThe preferred client authentication method that will be chosen for token requests.
no default

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.

Type
String
Default
none
Defined by
Pac4jAzureOidcClientProperties
cas.authn.pac4j.oidc[0].azure.client-nameName of the client mostly for UI purposes and uniqueness.
no default

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

Type
String
Default
none
Defined by
Pac4jAzureOidcClientProperties
cas.authn.pac4j.oidc[0].azure.connect-timeoutRead timeout of the OIDC client.
no default
Duration

Read timeout of the OIDC client.

Type
String
Default
none
Defined by
Pac4jAzureOidcClientProperties
cas.authn.pac4j.oidc[0].azure.css-classCSS class that should be assigned to this client.
no default

CSS class that should be assigned to this client.

Type
String
Default
none
Defined by
Pac4jAzureOidcClientProperties
cas.authn.pac4j.oidc[0].azure.custom-paramsCustom parameters to send along in authZ requests, etc.
no default

Custom parameters to send along in authZ requests, etc.

Type
Map<String,String>
Default
none
Defined by
Pac4jAzureOidcClientProperties
cas.authn.pac4j.oidc[0].azure.disable-pkceDisable PKCE support for the provider.
no default

Disable PKCE support for the provider.

Type
boolean
Default
none
Defined by
Pac4jAzureOidcClientProperties
cas.authn.pac4j.oidc[0].azure.display-nameIndicate the title or display name of the client for decoration and client presentation purposes.
no default

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.

Type
String
Default
none
Defined by
Pac4jAzureOidcClientProperties
cas.authn.pac4j.oidc[0].azure.enabledWhether the client/external identity provider should be considered active and enabled for integration purposes.
true

Whether the client/external identity provider should be considered active and enabled for integration purposes.

Type
boolean
Default
true
Defined by
Pac4jAzureOidcClientProperties
cas.authn.pac4j.oidc[0].azure.expire-session-with-tokenChecks if sessions expire with token expiration.
no default

Checks if sessions expire with token expiration.

Type
boolean
Default
none
Defined by
Pac4jAzureOidcClientProperties
cas.authn.pac4j.oidc[0].azure.federation.application-typeApplication type for the RP (client) entity statement.
web

Application type for the RP (client) entity statement.

Type
String
Default
web
Defined by
Pac4jOidcClientFederationProperties
cas.authn.pac4j.oidc[0].azure.federation.client-registration-typesRegistration types for the RP (client) entity statement.
explicit,automatic

Registration types for the RP (client) entity statement.

Type
List<String>
Default
explicit,automatic
Defined by
Pac4jOidcClientFederationProperties
cas.authn.pac4j.oidc[0].azure.federation.contact-emailsThe contact emails for this client.
no default

The contact emails for this client.

Type
List<String>
Default
none
Defined by
Pac4jOidcClientFederationProperties
cas.authn.pac4j.oidc[0].azure.federation.contact-nameThe contact name for this client.
no default

The contact name for this client.

Type
String
Default
none
Defined by
Pac4jOidcClientFederationProperties
cas.authn.pac4j.oidc[0].azure.federation.enabledWhether the federation is enabled.
no default

Whether the federation is enabled.

Type
boolean
Default
none
Defined by
Pac4jOidcClientFederationProperties
cas.authn.pac4j.oidc[0].azure.federation.grant-typesGrant types for the RP (client) entity statement.
authorization_code

Grant types for the RP (client) entity statement.

Type
List<String>
Default
authorization_code
Defined by
Pac4jOidcClientFederationProperties
cas.authn.pac4j.oidc[0].azure.federation.jwks.kidThe key identifier.
no default

The key identifier.

Type
String
Default
none
Defined by
Pac4jOidcClientJwksProperties
cas.authn.pac4j.oidc[0].azure.federation.response-typesResponse types for the RP (client) entity statement.
code

Response types for the RP (client) entity statement.

Type
List<String>
Default
code
Defined by
Pac4jOidcClientFederationProperties
cas.authn.pac4j.oidc[0].azure.federation.scopesScopes for the RP (client) entity statement.
openid,email,profile

Scopes for the RP (client) entity statement.

Type
List<String>
Default
openid,email,profile
Defined by
Pac4jOidcClientFederationProperties
cas.authn.pac4j.oidc[0].azure.federation.target-opThe target OIDC provider in federation.
no default

The target OIDC provider in federation.

Type
String
Default
none
Defined by
Pac4jOidcClientFederationProperties
cas.authn.pac4j.oidc[0].azure.federation.trust-anchorsThe trust anchors to use for federation.
no default

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.

Type
Map<String, String>
Default
none
Defined by
Pac4jOidcClientFederationProperties
cas.authn.pac4j.oidc[0].azure.federation.validity-in-daysValidity in days of the RP (client) entity statement.
90

Validity in days of the RP (client) entity statement.

Type
int
Default
90
Defined by
Pac4jOidcClientFederationProperties
cas.authn.pac4j.oidc[0].azure.include-access-token-claimsIf enabled, try to process the access token as a JWT and include its claims in the profile.
no default

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.

Type
boolean
Default
none
Defined by
Pac4jAzureOidcClientProperties
cas.authn.pac4j.oidc[0].azure.logout-urlLogout url used for this provider.
no default

Logout url used for this provider.

Type
String
Default
none
Defined by
Pac4jAzureOidcClientProperties
cas.authn.pac4j.oidc[0].azure.mapped-claimsList arbitrary mappings of claims when fetching user profiles.
no default

List arbitrary mappings of claims when fetching user profiles. Uses a "directed list" where the allowed syntax would be claim->attribute.

Type
List<String>
Default
none
Defined by
Pac4jAzureOidcClientProperties
cas.authn.pac4j.oidc[0].azure.max-clock-skewClock skew in order to account for drift, when validating id tokens.
no default
Duration

Clock skew in order to account for drift, when validating id tokens.

Type
String
Default
none
Defined by
Pac4jAzureOidcClientProperties
cas.authn.pac4j.oidc[0].azure.preferred-jws-algorithmThe JWS algorithm to use forcefully when validating ID tokens.
no default

The JWS algorithm to use forcefully when validating ID tokens. If none is defined, the first algorithm from metadata will be used.

Type
String
Default
none
Defined by
Pac4jAzureOidcClientProperties
cas.authn.pac4j.oidc[0].azure.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.
no default

The attribute found in the identity provider response that may be used to establish the authenticated user and build a profile for CAS.

Type
String
Default
none
Defined by
Pac4jAzureOidcClientProperties
cas.authn.pac4j.oidc[0].azure.private-key-jwt.jwks.kidThe key identifier.
no default

The key identifier.

Type
String
Default
none
Defined by
Pac4jOidcClientJwksProperties
cas.authn.pac4j.oidc[0].azure.propagate-logoutIndicate whether the logout should be propagated from the CAS server to the delegated identity server.
true

Indicate whether the logout should be propagated from the CAS server to the delegated identity server.

Type
boolean
Default
true
Defined by
Pac4jAzureOidcClientProperties
cas.authn.pac4j.oidc[0].azure.read-timeoutConnect timeout of the OIDC client.
no default
Duration

Connect timeout of the OIDC client.

Type
String
Default
none
Defined by
Pac4jAzureOidcClientProperties
cas.authn.pac4j.oidc[0].azure.response-modeThe response mode specifies how the result of the authorization request is formatted.
no default

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"

Type
String
Default
none
Defined by
Pac4jAzureOidcClientProperties
cas.authn.pac4j.oidc[0].azure.response-typeThe response type tells the authorization server which grant to execute.
no default

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

Type
String
Default
none
Defined by
Pac4jAzureOidcClientProperties
cas.authn.pac4j.oidc[0].azure.scopeRequested scope(s).
no default
SpEL

Requested scope(s).

Type
String
Default
none
Defined by
Pac4jAzureOidcClientProperties
Supports
Spring Expression Language
cas.authn.pac4j.oidc[0].azure.supported-client-authentication-methodsControl the list of supported client authentication methods that can be accepted and understood by this integration.
no default

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.

Type
String
Default
none
Defined by
Pac4jAzureOidcClientProperties
cas.authn.pac4j.oidc[0].azure.tenantAzure AD tenant name.
no default
SpEL

Azure AD tenant name. After tenant is configured, #getDiscoveryUri() property will be overridden.

Azure AD tenant name can take 4 different values:
  • common: Users with both a personal Microsoft account and a work or school account from Azure AD can sign in.
  • organizations: Only users with work or school accounts from Azure AD can sign in.
  • consumers: Only users with a personal Microsoft account can sign in.
  • Specific tenant domain name or ID: Only user with account under that the specified tenant can login
Type
String
Default
none
Defined by
Pac4jAzureOidcClientProperties
Supports
Spring Expression Language
cas.authn.pac4j.oidc[0].azure.token-expiration-advanceDefault time period advance (in seconds) for considering an access token expired.
no default
Duration

Default time period advance (in seconds) for considering an access token expired.

Type
String
Default
none
Defined by
Pac4jAzureOidcClientProperties
cas.authn.pac4j.oidc[0].azure.use-nonceWhether an initial nonce should be to used initially for replay attack mitigation.
no default

Whether an initial nonce should be to used initially for replay attack mitigation.

Type
boolean
Default
none
Defined by
Pac4jAzureOidcClientProperties
cas.authn.pac4j.oidc[0].azure.validate-logout-tokenControls whether the logout token submitted as a JWT should be validated for the correct signature, etc.
no default

Controls whether the logout token submitted as a JWT should be validated for the correct signature, etc.

Type
boolean
Default
none
Defined by
Pac4jAzureOidcClientProperties

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.

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