Microsoft Azure Active Directory Authentication

Azure Active Directory (Azure AD) is Microsoft’s cloud-based identity and access management service. The functionality described here allows one to authenticate credentials using Azure Active Directory as the account store and optionally fetch user attributes using Microsoft Graph.

Configuration

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-azuread-authentication</artifactId>
  <version>${cas.version}</version>
</dependency>
1
implementation "org.apereo.cas:cas-server-support-azuread-authentication:${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-azuread-authentication"
}

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

The configuration settings listed below are tagged as Required in the CAS configuration metadata. This flag indicates that the presence of the setting may be needed to activate or affect the behavior of the CAS feature and generally should be reviewed, possibly owned and adjusted. If the setting is assigned a default value, you do not need to strictly put the setting in your copy of the configuration, but should review it nonetheless to make sure it matches your deployment expectations.

  • cas.authn.azure-active-directory.password-encoder.encoding-algorithm=
  • The encoding algorithm to use such as MD5. Relevant when the type used is DEFAULT or GLIBC_CRYPT.

    org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

  • cas.authn.azure-active-directory.password-encoder.type=NONE
  • Define the password encoder type to use. Type may be specified as blank or NONE to disable password encoding. It may also refer to a fully-qualified class name that implements the Spring Security's PasswordEncoder interface if you wish you define your own encoder.

    The following types may be used:

    • NONE: No password encoding (i.e. plain-text) takes place.
    • DEFAULT: Use the DefaultPasswordEncoder of CAS. For message-digest algorithms via character-encoding and encoding-algorithm.
    • BCRYPT: Use the BCryptPasswordEncoder based on the strength provided and an optional secret.
    • SCRYPT: Use the SCryptPasswordEncoder.
    • PBKDF2: Use the Pbkdf2PasswordEncoder based on the strength provided and an optional secret.
    • STANDARD: Use the StandardPasswordEncoder based on the secret provided.
    • SSHA: Use the LdapShaPasswordEncoder supports Ldap SHA and SSHA (salted-SHA). The values are base-64 encoded and have the label {SHA</code> or {SSHA</code> prepended to the encoded hash.
    • GLIBC_CRYPT: Use the GlibcCryptPasswordEncoder based on the encoding-algorithm, strength provided and an optional secret.
    • org.example.MyEncoder: An implementation of PasswordEncoder of your own choosing.
    • file:///path/to/script.groovy: Path to a Groovy script charged with handling password encoding operations.

    org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

  • cas.authn.azure-active-directory.principal-transformation.groovy.location=
  • 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, specially if the script 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.

    org.apereo.cas.configuration.model.core.authentication.GroovyPrincipalTransformationProperties.

  • cas.authn.azure-active-directory.client-id=
  • Client id of the application.

    This setting supports the Spring Expression Language.

    org.apereo.cas.configuration.model.support.azuread.AzureActiveDirectoryAuthenticationProperties.

  • cas.authn.azure-active-directory.client-secret=
  • Client secret of the registered app in microsoft azure portal.

    This setting supports the Spring Expression Language.

    org.apereo.cas.configuration.model.support.azuread.AzureActiveDirectoryAuthenticationProperties.

  • cas.authn.azure-active-directory.tenant=
  • The microsoft tenant id.

    This setting supports the Spring Expression Language.

    org.apereo.cas.configuration.model.support.azuread.AzureActiveDirectoryAuthenticationProperties.

    The configuration settings listed below are tagged as Optional in the CAS configuration metadata. This flag indicates that the presence of the setting is not immediately necessary in the end-user CAS configuration, because a default value is assigned or the activation of the feature is not conditionally controlled by the setting value. You should only include this field in your configuration if you need to modify the default value.

  • cas.authn.azure-active-directory.password-encoder.character-encoding=UTF-8
  • The encoding algorithm to use such as 'UTF-8'. Relevant when the type used is DEFAULT.

    org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

  • cas.authn.azure-active-directory.password-encoder.hash-length=16
  • When used by PasswordEncoderTypes#ARGON2, it indicates the hash strength/length.

    org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

  • cas.authn.azure-active-directory.password-encoder.secret=
  • Secret to use with PasswordEncoderTypes#STANDARD, PasswordEncoderTypes#PBKDF2, PasswordEncoderTypes#BCRYPT, PasswordEncoderTypes#GLIBC_CRYPT password encoders. Secret usually is an optional setting.

    org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

  • cas.authn.azure-active-directory.password-encoder.strength=16
  • Strength or number of iterations to use for password hashing. Usually relevant when dealing with PasswordEncoderTypes#PBKDF2, PasswordEncoderTypes#BCRYPT or PasswordEncoderTypes#GLIBC_CRYPT. When used by PasswordEncoderTypes#ARGON2, it indicates the salt strength.

    org.apereo.cas.configuration.model.core.authentication.PasswordEncoderProperties.

  • cas.authn.azure-active-directory.principal-transformation.blocking-pattern=
  • A regular expression that will be used against the username to match for blocking/forbidden values. If a match is found, an exception will be thrown and principal transformation will fail.

    This setting supports the Spring Expression Language.

    org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.

  • cas.authn.azure-active-directory.principal-transformation.case-conversion=NONE
  • Indicate whether the principal identifier should be transformed into upper-case, lower-case, etc. Available values are as follows:

    • NONE: No conversion.
    • LOWERCASE: Lowercase conversion.
    • UPPERCASE: Uppercase conversion.

    org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.

  • cas.authn.azure-active-directory.principal-transformation.pattern=
  • A regular expression that will be used against the provided username for username extractions. On a successful match, the first matched group in the pattern will be used as the extracted username.

    This setting supports the Spring Expression Language.

    org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.

  • cas.authn.azure-active-directory.principal-transformation.prefix=
  • Prefix to add to the principal id prior to authentication.

    This setting supports the Spring Expression Language.

    org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.

  • cas.authn.azure-active-directory.principal-transformation.suffix=
  • Suffix to add to the principal id prior to authentication.

    This setting supports the Spring Expression Language.

    org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties.

  • cas.authn.azure-active-directory.credential-criteria=
  • A number of authentication handlers are allowed to determine whether they can operate on the provided credential and as such lend themselves to be tried and tested during the authentication handler selection phase. The credential criteria may be one of the following options:

    • 1) A regular expression pattern that is tested against the credential identifier.
    • 2) A fully qualified class name of your own design that implements Predicate.
    • 3) Path to an external Groovy script that implements the same interface.

    org.apereo.cas.configuration.model.support.azuread.AzureActiveDirectoryAuthenticationProperties.

  • cas.authn.azure-active-directory.login-url=https://login.microsoftonline.com/common/
  • This URL of the security token service that CAS goes to for acquiring tokens for resources and users This URL allows CAS to establish what is called an 'authority'. You can think of the authority as the directory issuing the identities/tokens. The login URL here is then composed of https:///</code>, where 'instance' is the Azure AD host (such as https://login.microsoftonline.com) and 'tenant' is the domain name (such as contoso.onmicrosoft.com) or tenant ID of the directory. Examples of authority URL are:

    • https://login.microsoftonline.com/f31e6716-26e8-4651-b323-2563936b4163: for a single tenant application defined in the tenant
    • https://login.microsoftonline.com/contoso.onmicrosoft.com: This representation is like the previous one, but uses the tenant domain name instead of the tenant Id.
    • https://login.microsoftonline.de/contoso.de: also uses a domain name, but in this case the Azure AD tenant admins have set a custom domain for their tenant, and the instance URL here is for the German national cloud.
    • https://login.microsoftonline.com/common: in the case of a multi-tenant application, that is an application available in several Azure AD tenants.
    • It can finally be an Active Directory Federation Services (ADFS) URL, which is recognized with the convention that the URL should contain adfs like https://contoso.com/adfs.
    </p>

    org.apereo.cas.configuration.model.support.azuread.AzureActiveDirectoryAuthenticationProperties.

    </div> </td> </tr>

  • cas.authn.azure-active-directory.name=
  • The name of the authentication handler.

    org.apereo.cas.configuration.model.support.azuread.AzureActiveDirectoryAuthenticationProperties.

  • cas.authn.azure-active-directory.order=
  • The order of this authentication handler in the chain.

    org.apereo.cas.configuration.model.support.azuread.AzureActiveDirectoryAuthenticationProperties.

  • cas.authn.azure-active-directory.resource=https://graph.microsoft.com/
  • Resource url for the graph API to fetch attributes.

    org.apereo.cas.configuration.model.support.azuread.AzureActiveDirectoryAuthenticationProperties.

  • cas.authn.azure-active-directory.state=
  • Define the scope and state of this authentication handler and the lifecycle in which it can be invoked or activated. Available values are as follows:

    • ACTIVE: Active authentication handler, and is invoked by default automatically to verify credentials globally.
    • STANDBY: Authentication handler is in a semi-enabled state, waiting to be called only on-demand when explicitly asked for.

    org.apereo.cas.configuration.model.support.azuread.AzureActiveDirectoryAuthenticationProperties.