APEREO CASDocumentation

Enterprise Authentication for All Earthlings and Beyond

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

LDAP Authentication

LDAP integration is enabled by including the following dependency in the overlay:

Show in CAS Initializr Generate CAS Server WAR Overlay 


1
2
3
4
5



<dependency>
    <groupId>org.apereo.cas</groupId>
    <artifactId>cas-server-support-ldap</artifactId>
    <version>${cas.version}</version>
</dependency>





1



implementation "org.apereo.cas:cas-server-support-ldap:${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-ldap"
}





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-ldap"
}

Configuration

CAS authenticates a username/password against an LDAP directory such as Active Directory or OpenLDAP. There are numerous directory architectures and we provide configuration for four common cases.

Note that CAS will automatically create the appropriate components internally based on the settings specified below. If you wish to authenticate against more than one LDAP server, increment the index and specify the settings for the next LDAP server.

Note: Attributes retrieved as part of LDAP authentication are merged with all attributes retrieved from other attribute repository sources, if any. Attributes retrieved directly as part of LDAP authentication trump all other attributes.

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

cas.authn.ldap[0].base-dnBase DN to use.
no default
Required

Base DN to use. There may be scenarios where different parts of a single LDAP tree could be considered as base-dns. Rather than duplicating the LDAP configuration block for each individual base-dn, each entry can be specified and joined together using a special delimiter character. The user DN is retrieved using the combination of all base-dn and DN resolvers in the order defined. DN resolution should fail if multiple DNs are found. Otherwise the first DN found is returned. Usual syntax is: subtreeA,dc=example,dc=net|subtreeC,dc=example,dc=net.

Type
String
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].bind-credentialThe bind credential to use when connecting to LDAP.
no default
Required

The bind credential to use when connecting to LDAP.

Type
String
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].bind-dnThe bind DN to use when connecting to LDAP.
no default
Required
The bind DN to use when connecting to LDAP. LDAP connection configuration injected into the LDAP connection pool can be initialized with the following parameters:
  • bindDn/bindCredential provided - Use the provided credentials to bind when initializing connections.
  • bindDn/bindCredential set to * - Use a fast-bind strategy to initialize the pool.
  • bindDn/bindCredential set to blank - Skip connection initializing; perform operations anonymously.
  • SASL mechanism provided - Use the given SASL mechanism to bind when initializing connections.
Type
String
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].ldap-urlThe LDAP url to the server.
no default
Required

The LDAP url to the server. More than one may be specified, separated by space and/or comma.

Type
String
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].password-encoder.encoding-algorithmThe encoding algorithm to use such as MD5 .
no default
Required

The encoding algorithm to use such as MD5. Relevant when the type used is DEFAULT or GLIBC_CRYPT. When used with PasswordEncoderTypes#PBKDF2, it should be one of PBKDF2WithHmacSHA1, PBKDF2WithHmacSHA256 or PBKDF2WithHmacSHA512.

Type
String
Default
none
Defined by
PasswordEncoderProperties
cas.authn.ldap[0].password-encoder.typeDefine the password encoder type to use.
NONE
Required

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} or {SSHA} 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.
Type
String
Default
NONE
Defined by
PasswordEncoderProperties
cas.authn.ldap[0].password-policy.groovy.locationHandle password policy via Groovy script.
no default
Required

Handle password policy via Groovy script. 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.ldap[0].principal-transformation.groovy.locationTransform usernames using a Groovy resource.
no default
Required

Transform usernames using a Groovy resource. 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.ldap[0].search-filterUser filter to use for searching.
no default
Required

User filter to use for searching. Syntax is cn={user} or cn={0}.

You may also provide an external groovy script in the syntax of file:/path/to/GroovyScript.groovy to fully build the final filter template dynamically.

Type
String
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].typeThe authentication type.
no default
Required
The authentication type.
  • AD - Users authenticate with sAMAccountName.
  • AUTHENTICATED - Manager bind/search type of authentication. If {@code} principalAttributePassword} is empty then a user simple bind is done to validate credentials. Otherwise the given attribute is compared with the given principalAttributePassword using the SHA encrypted value of it.
  • ANONYMOUS: Similar semantics as AUTHENTICATED except no bindDn and bindCredential may be specified to initialize the connection. If principalAttributePassword is empty then a user simple bind is done to validate credentials. Otherwise the given attribute is compared with the given principalAttributePassword using the SHA encrypted value of it.
  • DIRECT: Direct Bind - Compute user DN from format string and perform simple bind. This is relevant when no search is required to compute the DN needed for a bind operation. Use cases for this type are: 1) All users are under a single branch in the directory, e.g. ou=Users,dc=example,dc=org. 2) The username provided on the CAS login form is part of the DN, e.g. uid=%s,ou=Users,dc=example,dc=org.
Available values are as follows:
  • AD: Active Directory.
  • AUTHENTICATED: Authenticated Search.
  • DIRECT: Direct Bind.
  • ANONYMOUS: Anonymous Search.
Type
AbstractLdapAuthenticationProperties.AuthenticationTypes
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldapCollection of settings related to LDAP authentication.
no default

Collection of settings related to LDAP authentication. These settings are required to be indexed (i.e. ldap[0].xyz).

Type
List<LdapAuthenticationProperties>
Default
none
Defined by
AuthenticationProperties
cas.authn.ldap[0].additional-attributesList of additional attributes to retrieve, if any.
no default

List of additional attributes to retrieve, if any.

Type
List<String>
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].allow-missing-principal-attribute-valueFlag to indicate whether CAS should block authentication if a specific/configured principal id attribute is not found.
true

Flag to indicate whether CAS should block authentication if a specific/configured principal id attribute is not found.

Type
boolean
Default
true
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].allow-multiple-dnsWhether search/query results are allowed to match on multiple DNs, or whether a single unique DN is expected for the result.
no default

Whether search/query results are allowed to match on multiple DNs, or whether a single unique DN is expected for the result.

Type
boolean
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].allow-multiple-entriesSet if multiple Entries are allowed.
no default

Set if multiple Entries are allowed.

Type
boolean
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].allow-multiple-principal-attribute-valuesSets a flag that determines whether multiple values are allowed for the #principalAttributeId .
no default

Sets a flag that determines whether multiple values are allowed for the #principalAttributeId. This flag only has an effect if #principalAttributeId is configured. If multiple values are detected when the flag is false, the first value is used and a warning is logged. If multiple values are detected when the flag is true, an exception is raised.

Type
boolean
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].binary-attributesIndicate the collection of attributes that are to be tagged and processed as binary attributes by the underlying search resolver.
no default

Indicate the collection of attributes that are to be tagged and processed as binary attributes by the underlying search resolver.

Type
List<String>
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].block-wait-timeThe length of time the pool will block.
no default
Duration

The length of time the pool will block. By default the pool will block indefinitely and there is no guarantee that waiting threads will be serviced in the order in which they made their request. This option should be used with a blocking connection pool when you need to control the exact number of connections that can be created

Type
String
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].collect-dn-attributeWhen entry DN should be called as an attribute and stored into the principal.
no default

When entry DN should be called as an attribute and stored into the principal.

Type
boolean
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].connect-timeoutSets the maximum amount of time that connects will block.
no default
Duration

Sets the maximum amount of time that connects will block.

Type
String
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].connection-strategyIf multiple URLs are provided as the ldapURL this describes how each URL will be processed.
no default
If multiple URLs are provided as the ldapURL this describes how each URL will be processed.
  • ACTIVE_PASSIVE First LDAP will be used for every request unless it fails and then the next shall be used.
  • ROUND_ROBIN For each new connection the next url in the list will be used.
  • RANDOM For each new connection a random LDAP url will be selected.
  • DNS_SRV LDAP urls based on DNS SRV records of the configured/given LDAP url will be used.
Type
String
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].credential-criteriaA 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.
no default
Regex
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.
Type
String
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].deref-aliasesDefine how aliases are de-referenced.
no default
Define how aliases are de-referenced. Accepted values are:
  • NEVER
  • SEARCHING: dereference when searching the entries beneath the starting point but not when searching for the starting entry.
  • FINDING: dereference when searching for the starting entry but not when searching the entries beneath the starting point.
  • ALWAYS: dereference when searching for the starting entry and when searching the entries beneath the starting point.
Type
String
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].disable-poolingWhether to use a pooled connection factory in components.
no default

Whether to use a pooled connection factory in components.

Type
boolean
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].dn-formatSpecify the dn format accepted by the AD authenticator, etc.
no default

Specify the dn format accepted by the AD authenticator, etc. Example format might be uid=%s,ou=people,dc=example,dc=org.

Type
String
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].enhance-with-entry-resolverWhether specific search entry resolvers need to be set on the authenticator, or the default should be used.
no default

Whether specific search entry resolvers need to be set on the authenticator, or the default should be used.

Type
boolean
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].fail-fastAttempt to populate the connection pool early on startup and fail quickly if something goes wrong.
no default

Attempt to populate the connection pool early on startup and fail quickly if something goes wrong.

Type
boolean
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].follow-referralsSet if search referrals should be followed.
no default

Set if search referrals should be followed.

Type
boolean
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].hostname-verifierHostname verification options.
no default
Hostname verification options. Available values are as follows:
  • DEFAULT: Default option, forcing verification.
  • ANY: Skip hostname verification and allow all.
Type
AbstractLdapProperties.LdapHostnameVerifierOptions
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].idle-timeRemoves connections from the pool based on how long they have been idle in the available queue.
no default
Duration

Removes connections from the pool based on how long they have been idle in the available queue. Prunes connections that have been idle for more than the indicated amount.

Type
String
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].keystorePath to the keystore used for SSL connections.
no default
SpEL

Path to the keystore used for SSL connections. Typically contains SSL certificates for the LDAP server.

Type
String
Default
none
Defined by
LdapAuthenticationProperties
Supports
Spring Expression Language
cas.authn.ldap[0].keystore-passwordKeystore password.
no default
SpEL

Keystore password.

Type
String
Default
none
Defined by
LdapAuthenticationProperties
Supports
Spring Expression Language
cas.authn.ldap[0].keystore-typeThe type of keystore.
no default

The type of keystore. PKCS12 or JKS. If left blank, defaults to the default keystore type indicated by the underlying Java platform.

Type
String
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].max-pool-sizeMaximum LDAP connection pool size which the pool can use to grow.
no default

Maximum LDAP connection pool size which the pool can use to grow.

Type
int
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].min-pool-sizeMinimum LDAP connection pool size.
no default

Minimum LDAP connection pool size. Size the pool should be initialized to and pruned to

Type
int
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].nameName of the LDAP handler.
no default

Name of the LDAP handler.

Type
String
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].orderOrder of the authentication handler in the chain.
no default

Order of the authentication handler in the chain.

Type
Integer
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].page-sizeRequest that the server return results in batches of a specific size.
no default

Request that the server return results in batches of a specific size. See RFC 2696. This control is often used to work around server result size limits. A negative/zero value disables paged requests.

Type
int
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].password-encoder.character-encodingThe encoding algorithm to use such as 'UTF-8'.
UTF-8

The encoding algorithm to use such as 'UTF-8'. Relevant when the type used is DEFAULT.

Type
String
Default
UTF-8
Defined by
PasswordEncoderProperties
cas.authn.ldap[0].password-encoder.hash-lengthWhen used by PasswordEncoderTypes#ARGON2 , it indicates the hash strength/length.
16

When used by PasswordEncoderTypes#ARGON2, it indicates the hash strength/length.

Type
int
Default
16
Defined by
PasswordEncoderProperties
cas.authn.ldap[0].password-encoder.iterationsWhen used by PasswordEncoderTypes#PBKDF2 , it indicates the required number of iterations.
310000

When used by PasswordEncoderTypes#PBKDF2, it indicates the required number of iterations.

Type
int
Default
310000
Defined by
PasswordEncoderProperties
cas.authn.ldap[0].password-encoder.secretSecret to use with PasswordEncoderTypes#STANDARD , PasswordEncoderTypes#PBKDF2 , PasswordEncoderTypes#BCRYPT , PasswordEncoderTypes#GLIBC_CRYPT password encoders.
no default

Secret to use with PasswordEncoderTypes#STANDARD, PasswordEncoderTypes#PBKDF2, PasswordEncoderTypes#BCRYPT, PasswordEncoderTypes#GLIBC_CRYPT password encoders. Secret usually is an optional setting.

Type
String
Default
none
Defined by
PasswordEncoderProperties
cas.authn.ldap[0].password-encoder.strengthStrength or number of iterations to use for password hashing.
16

Strength or number of iterations to use for password hashing. Usually relevant when dealing with PasswordEncoderTypes#BCRYPT, PasswordEncoderTypes#PBKDF2 or PasswordEncoderTypes#GLIBC_CRYPT. When used by PasswordEncoderTypes#ARGON2 or PasswordEncoderTypes#PBKDF2, it indicates the salt strength.

Type
int
Default
16
Defined by
PasswordEncoderProperties
cas.authn.ldap[0].password-policy.account-state-handling-enabledIndicates whether account state handling should be enabled to process warnings or errors reported back from the authentication response, produced by the source.
true

Indicates whether account state handling should be enabled to process warnings or errors reported back from the authentication response, produced by the source.

Type
boolean
Default
true
Defined by
LdapPasswordPolicyProperties
cas.authn.ldap[0].password-policy.custom-policy-classAn implementation of a policy class that knows how to handle LDAP responses.
no default

An implementation of a policy class that knows how to handle LDAP responses. The class must be an implementation of org.ldaptive.auth.AuthenticationResponseHandler.

Type
String
Default
none
Defined by
LdapPasswordPolicyProperties
cas.authn.ldap[0].password-policy.display-warning-on-matchIndicates if warning should be displayed, when the ldap attribute value matches the #warningAttributeValue .
true

Indicates if warning should be displayed, when the ldap attribute value matches the #warningAttributeValue.

Type
boolean
Default
true
Defined by
LdapPasswordPolicyProperties
cas.authn.ldap[0].password-policy.enabledWhether password policy should be enabled.
true

Whether password policy should be enabled.

Type
boolean
Default
true
Defined by
LdapPasswordPolicyProperties
cas.authn.ldap[0].password-policy.login-failuresWhen dealing with FreeIPA, indicates the number of allows login failures.
5

When dealing with FreeIPA, indicates the number of allows login failures.

Type
int
Default
5
Defined by
LdapPasswordPolicyProperties
cas.authn.ldap[0].password-policy.password-expiration-number-of-daysThis is used to calculate an expiration period for the account password.
180

This is used to calculate an expiration period for the account password. When defined, LDAP password policy handling will use the pwdLastSet attribute which must be returned from the LDAP authentication attempt. LDAP password policy handling will emit a warning for the pwdLastSet value plus the expiration amount. A negative value will disable the operations that calculate the expiration period.

Type
int
Default
180
Defined by
LdapPasswordPolicyProperties
cas.authn.ldap[0].password-policy.policy-attributesKey-value structure (Map) that indicates a list of boolean attributes as keys.
no default

Key-value structure (Map) that indicates a list of boolean attributes as keys. If either attribute value is true, indicating an account state is flagged, the corresponding error can be thrown. Example accountLocked=javax.security.auth.login.AccountLockedException

Type
Map<String, Class<? extends LoginException>>
Default
none
Defined by
LdapPasswordPolicyProperties
cas.authn.ldap[0].password-policy.strategyDecide how authentication should handle password policy changes.
DEFAULT
Decide how authentication should handle password policy changes. Available values are as follows:
  • DEFAULT: Default option to handle policy changes.
  • GROOVY: Handle account password policies via Groovy.
  • REJECT_RESULT_CODE: Strategy to only activate password policy if the authentication response code is not blocked.
Type
PasswordPolicyProperties.PasswordPolicyHandlingOptions
Default
DEFAULT
Defined by
LdapPasswordPolicyProperties
cas.authn.ldap[0].password-policy.typeLDAP type.
GENERIC

LDAP type.

Type
AbstractLdapProperties.LdapType
Default
GENERIC
Defined by
LdapPasswordPolicyProperties
cas.authn.ldap[0].password-policy.warn-allAlways display the password expiration warning regardless.
no default

Always display the password expiration warning regardless.

Type
boolean
Default
none
Defined by
LdapPasswordPolicyProperties
cas.authn.ldap[0].password-policy.warning-attribute-nameUsed by an account state handling policy that only calculates account warnings in case the entry carries this attribute.
no default

Used by an account state handling policy that only calculates account warnings in case the entry carries this attribute.

Type
String
Default
none
Defined by
LdapPasswordPolicyProperties
cas.authn.ldap[0].password-policy.warning-attribute-valueUsed by an account state handling policy that only calculates account warnings in case the entry carries an attribute #warningAttributeName whose value matches this field.
no default

Used by an account state handling policy that only calculates account warnings in case the entry carries an attribute #warningAttributeName whose value matches this field.

Type
String
Default
none
Defined by
LdapPasswordPolicyProperties
cas.authn.ldap[0].password-policy.warning-daysThis is used to calculate a warning period to see if account expiry is within the calculated window.
30

This is used to calculate a warning period to see if account expiry is within the calculated window.

Type
int
Default
30
Defined by
LdapPasswordPolicyProperties
cas.authn.ldap[0].pool-passivatorYou may receive unexpected LDAP failures, when CAS is configured to authenticate using DIRECT or AUTHENTICATED types and LDAP is locked down to not allow anonymous binds/searches.
no default
You may receive unexpected LDAP failures, when CAS is configured to authenticate using DIRECT or AUTHENTICATED types and LDAP is locked down to not allow anonymous binds/searches. Every second attempt with a given LDAP connection from the pool would fail if it was on the same connection as a failed login attempt, and the regular connection validator would similarly fail. When a connection is returned back to a pool, it still may contain the principal and credentials from the previous attempt. Before the next bind attempt using that connection, the validator tries to validate the connection again but fails because it’s no longer trying with the configured bind credentials but with whatever user DN was used in the previous step. Given the validation failure, the connection is closed and CAS would deny access by default. Passivators attempt to reconnect to LDAP with the configured bind credentials, effectively resetting the connection to what it should be after each bind request. Furthermore if you are seeing errors in the logs that resemble a 'Operation exception encountered, reopening connection' type of message, this usually is an indication that the connection pool’s validation timeout established and created by CAS is greater than the timeout configured in the LDAP server, or more likely, in the load balancer in front of the LDAP servers. You can adjust the LDAP server session’s timeout for connections, or you can teach CAS to use a validity period that is equal or less than the LDAP server session’s timeout. Accepted values are:
  • NONE: No passivation takes place.
  • BIND: The default behavior which passivates a connection by performing a bind operation on it. This option requires the availability of bind credentials when establishing connections to LDAP.
Type
String
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].principal-attribute-idThe attribute to use as the principal identifier built during and upon a successful authentication attempt.
no default

The attribute to use as the principal identifier built during and upon a successful authentication attempt.

Type
String
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].principal-attribute-listList of attributes to retrieve from LDAP.
no default

List of attributes to retrieve from LDAP. Attributes can be virtually remapped to multiple names. Example cn:commonName,givenName,eduPersonTargettedId:SOME_IDENTIFIER.

To fetch and resolve attributes that carry tags/options, consider tagging the mapped attribute as such: homePostalAddress:homePostalAddress;.

Type
List<String>
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].principal-attribute-passwordIf principalAttributePassword is empty then a user simple bind is done to validate credentials otherwise the given attribute is compared with the given principalAttributePassword using the SHA encrypted value of it.
no default

If principalAttributePassword is empty then a user simple bind is done to validate credentials otherwise the given attribute is compared with the given principalAttributePassword using the SHA encrypted value of it.

For the anonymous authentication type, if principalAttributePassword is empty then a user simple bind is done to validate credentials otherwise the given attribute is compared with the given principalAttributePassword using the SHA encrypted value of it.

Type
String
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].principal-dn-attribute-nameName of attribute to be used for principal's DN.
principalLdapDn

Name of attribute to be used for principal's DN.

Type
String
Default
principalLdapDn
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].principal-transformation.blocking-patternA regular expression that will be used against the username to match for blocking/forbidden values.
no default
SpEL

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.

Type
String
Default
none
Defined by
PrincipalTransformationProperties
Supports
Spring Expression Language
cas.authn.ldap[0].principal-transformation.case-conversionIndicate whether the principal identifier should be transformed into upper-case, lower-case, etc.
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.
Type
PrincipalTransformationProperties.CaseConversion
Default
NONE
Defined by
PrincipalTransformationProperties
cas.authn.ldap[0].principal-transformation.patternA regular expression that will be used against the provided username for username extractions.
no default
SpEL

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.

Type
String
Default
none
Defined by
PrincipalTransformationProperties
Supports
Spring Expression Language
cas.authn.ldap[0].principal-transformation.prefixPrefix to add to the principal id prior to authentication.
no default
SpEL

Prefix to add to the principal id prior to authentication.

Type
String
Default
none
Defined by
PrincipalTransformationProperties
Supports
Spring Expression Language
cas.authn.ldap[0].principal-transformation.suffixSuffix to add to the principal id prior to authentication.
no default
SpEL

Suffix to add to the principal id prior to authentication.

Type
String
Default
none
Defined by
PrincipalTransformationProperties
Supports
Spring Expression Language
cas.authn.ldap[0].prune-periodRemoves connections from the pool based on how long they have been idle in the available queue.
no default
Duration

Removes connections from the pool based on how long they have been idle in the available queue. Run the pruning process at the indicated interval.

Type
String
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].resolve-from-attributeIf this attribute is set, the value found in the first attribute value will be used in place of the DN.
no default

If this attribute is set, the value found in the first attribute value will be used in place of the DN.

Type
String
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].response-timeoutDuration of time to wait for responses.
no default
Duration

Duration of time to wait for responses.

Type
String
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].sasl-authorization-idSASL authorization id.
no default

SASL authorization id.

Type
String
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].sasl-mechanismThe SASL mechanism.
no default

The SASL mechanism.

Type
String
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].sasl-mutual-authWhether SASL mutual authentication is enabled.
no default

Whether SASL mutual authentication is enabled.

Type
Boolean
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].sasl-quality-of-protectionSASL quality of protected.
no default

SASL quality of protected.

Type
String
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].sasl-realmThe SASL realm.
no default

The SASL realm.

Type
String
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].sasl-security-strengthSASL security strength.
no default

SASL security strength.

Type
String
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].search-entry-handlers.case-change.attribute-name-case-changeThe Attribute name case change.
no default

The Attribute name case change.

Type
String
Default
none
Defined by
CaseChangeSearchEntryHandlersProperties
cas.authn.ldap[0].search-entry-handlers.case-change.attribute-namesThe Attribute names.
no default

The Attribute names.

Type
List<String>
Default
none
Defined by
CaseChangeSearchEntryHandlersProperties
cas.authn.ldap[0].search-entry-handlers.case-change.attribute-value-case-changeThe Attribute value case change.
no default

The Attribute value case change.

Type
String
Default
none
Defined by
CaseChangeSearchEntryHandlersProperties
cas.authn.ldap[0].search-entry-handlers.case-change.dn-case-changeThe Dn case change.
no default

The Dn case change.

Type
String
Default
none
Defined by
CaseChangeSearchEntryHandlersProperties
cas.authn.ldap[0].search-entry-handlers.dn-attribute.add-if-existsThe Add if exists.
no default

The Add if exists.

Type
boolean
Default
none
Defined by
DnAttributeSearchEntryHandlersProperties
cas.authn.ldap[0].search-entry-handlers.dn-attribute.dn-attribute-nameThe Dn attribute name.
entryDN

The Dn attribute name.

Type
String
Default
entryDN
Defined by
DnAttributeSearchEntryHandlersProperties
cas.authn.ldap[0].search-entry-handlers.merge-attribute.attribute-namesThe Attribute names.
no default

The Attribute names.

Type
List<String>
Default
none
Defined by
MergeAttributesSearchEntryHandlersProperties
cas.authn.ldap[0].search-entry-handlers.merge-attribute.merge-attribute-nameThe Merge attribute name.
no default

The Merge attribute name.

Type
String
Default
none
Defined by
MergeAttributesSearchEntryHandlersProperties
cas.authn.ldap[0].search-entry-handlers.primary-group-id.base-dnThe Base dn.
no default

The Base dn.

Type
String
Default
none
Defined by
PrimaryGroupIdSearchEntryHandlersProperties
cas.authn.ldap[0].search-entry-handlers.primary-group-id.group-filterThe Group filter.
(&(objectClass=group)(objectSid={0}))

The Group filter.

Type
String
Default
(&(objectClass=group)(objectSid={0}))
Defined by
PrimaryGroupIdSearchEntryHandlersProperties
cas.authn.ldap[0].search-entry-handlers.recursive.merge-attributesThe Merge attributes.
no default

The Merge attributes.

Type
List<String>
Default
none
Defined by
RecursiveSearchEntryHandlersProperties
cas.authn.ldap[0].search-entry-handlers.recursive.search-attributeThe Search attribute.
no default

The Search attribute.

Type
String
Default
none
Defined by
RecursiveSearchEntryHandlersProperties
cas.authn.ldap[0].search-entry-handlers.search-referral.limitThe default referral limit.
10

The default referral limit.

Type
int
Default
10
Defined by
FollowReferralSearchEntryHandlersProperties
cas.authn.ldap[0].search-entry-handlers.search-result.limitThe default referral limit.
10

The default referral limit.

Type
int
Default
10
Defined by
FollowResultSearchEntryHandlersProperties
cas.authn.ldap[0].search-entry-handlers.typeThe type of search entry handler to choose.
no default
The type of search entry handler to choose. Available values are as follows:
  • FOLLOW_SEARCH_REFERRAL: Provides handling of an ldap referral for search operations.
  • FOLLOW_SEARCH_RESULT_REFERENCE: Provides handling of an ldap continuation reference for search operations.
  • ACTIVE_DIRECTORY: Process the entry results fetched from active directory and check for account status controls for disabled/expired accounts, etc.
  • OBJECT_GUID: Object guid search entry handler. Handles the objectGUID attribute fetching and conversion.
  • OBJECT_SID: Object sid search entry handler. Handles the objectSid attribute fetching and conversion.
  • CASE_CHANGE: Case change search entry handler. Provides the ability to modify the case of search entry DNs, attribute names, and attribute values.
  • DN_ATTRIBUTE_ENTRY: DN attribute entry handler. Adds the entry DN as an attribute to the result set. Provides a client side implementation of RFC 5020.
  • MERGE: Merge search entry handler. Merges the values of one or more attributes into a single attribute.
  • PRIMARY_GROUP: Primary group search handler. Constructs the primary group SID and then searches for that group and puts it's DN in the memberOf attribute of the original search entry.
  • RANGE_ENTRY: Range entry search handler. Rewrites attributes returned from Active Directory to include all values by performing additional searches.
  • RECURSIVE_ENTRY: Recursive entry search handler. This recursively searches based on a supplied attribute and merges those results into the original entry.
  • MERGE_ENTRIES: Merge entries handler. Merges the values of one or more attributes in all entries into a single attribute. The merged attribute may or may not already exist on the entry. If it does exist it's existing values will remain intact.
Type
LdapSearchEntryHandlersProperties.SearchEntryHandlerTypes
Default
none
Defined by
LdapSearchEntryHandlersProperties
cas.authn.ldap[0].search-entry-handlers[0].case-change.attribute-name-case-changeThe Attribute name case change.
no default

The Attribute name case change.

Type
String
Default
none
Defined by
CaseChangeSearchEntryHandlersProperties
cas.authn.ldap[0].search-entry-handlers[0].case-change.attribute-namesThe Attribute names.
no default

The Attribute names.

Type
List<String>
Default
none
Defined by
CaseChangeSearchEntryHandlersProperties
cas.authn.ldap[0].search-entry-handlers[0].case-change.attribute-value-case-changeThe Attribute value case change.
no default

The Attribute value case change.

Type
String
Default
none
Defined by
CaseChangeSearchEntryHandlersProperties
cas.authn.ldap[0].search-entry-handlers[0].case-change.dn-case-changeThe Dn case change.
no default

The Dn case change.

Type
String
Default
none
Defined by
CaseChangeSearchEntryHandlersProperties
cas.authn.ldap[0].search-entry-handlers[0].dn-attribute.add-if-existsThe Add if exists.
no default

The Add if exists.

Type
boolean
Default
none
Defined by
DnAttributeSearchEntryHandlersProperties
cas.authn.ldap[0].search-entry-handlers[0].dn-attribute.dn-attribute-nameThe Dn attribute name.
entryDN

The Dn attribute name.

Type
String
Default
entryDN
Defined by
DnAttributeSearchEntryHandlersProperties
cas.authn.ldap[0].search-entry-handlers[0].merge-attribute.attribute-namesThe Attribute names.
no default

The Attribute names.

Type
List<String>
Default
none
Defined by
MergeAttributesSearchEntryHandlersProperties
cas.authn.ldap[0].search-entry-handlers[0].merge-attribute.merge-attribute-nameThe Merge attribute name.
no default

The Merge attribute name.

Type
String
Default
none
Defined by
MergeAttributesSearchEntryHandlersProperties
cas.authn.ldap[0].search-entry-handlers[0].primary-group-id.base-dnThe Base dn.
no default

The Base dn.

Type
String
Default
none
Defined by
PrimaryGroupIdSearchEntryHandlersProperties
cas.authn.ldap[0].search-entry-handlers[0].primary-group-id.group-filterThe Group filter.
(&(objectClass=group)(objectSid={0}))

The Group filter.

Type
String
Default
(&(objectClass=group)(objectSid={0}))
Defined by
PrimaryGroupIdSearchEntryHandlersProperties
cas.authn.ldap[0].search-entry-handlers[0].recursive.merge-attributesThe Merge attributes.
no default

The Merge attributes.

Type
List<String>
Default
none
Defined by
RecursiveSearchEntryHandlersProperties
cas.authn.ldap[0].search-entry-handlers[0].recursive.search-attributeThe Search attribute.
no default

The Search attribute.

Type
String
Default
none
Defined by
RecursiveSearchEntryHandlersProperties
cas.authn.ldap[0].search-entry-handlers[0].search-referral.limitThe default referral limit.
10

The default referral limit.

Type
int
Default
10
Defined by
FollowReferralSearchEntryHandlersProperties
cas.authn.ldap[0].search-entry-handlers[0].search-result.limitThe default referral limit.
10

The default referral limit.

Type
int
Default
10
Defined by
FollowResultSearchEntryHandlersProperties
cas.authn.ldap[0].search-entry-handlers[0].typeThe type of search entry handler to choose.
no default
The type of search entry handler to choose. Available values are as follows:
  • FOLLOW_SEARCH_REFERRAL: Provides handling of an ldap referral for search operations.
  • FOLLOW_SEARCH_RESULT_REFERENCE: Provides handling of an ldap continuation reference for search operations.
  • ACTIVE_DIRECTORY: Process the entry results fetched from active directory and check for account status controls for disabled/expired accounts, etc.
  • OBJECT_GUID: Object guid search entry handler. Handles the objectGUID attribute fetching and conversion.
  • OBJECT_SID: Object sid search entry handler. Handles the objectSid attribute fetching and conversion.
  • CASE_CHANGE: Case change search entry handler. Provides the ability to modify the case of search entry DNs, attribute names, and attribute values.
  • DN_ATTRIBUTE_ENTRY: DN attribute entry handler. Adds the entry DN as an attribute to the result set. Provides a client side implementation of RFC 5020.
  • MERGE: Merge search entry handler. Merges the values of one or more attributes into a single attribute.
  • PRIMARY_GROUP: Primary group search handler. Constructs the primary group SID and then searches for that group and puts it's DN in the memberOf attribute of the original search entry.
  • RANGE_ENTRY: Range entry search handler. Rewrites attributes returned from Active Directory to include all values by performing additional searches.
  • RECURSIVE_ENTRY: Recursive entry search handler. This recursively searches based on a supplied attribute and merges those results into the original entry.
  • MERGE_ENTRIES: Merge entries handler. Merges the values of one or more attributes in all entries into a single attribute. The merged attribute may or may not already exist on the entry. If it does exist it's existing values will remain intact.
Type
LdapSearchEntryHandlersProperties.SearchEntryHandlerTypes
Default
none
Defined by
LdapSearchEntryHandlersProperties
cas.authn.ldap[0].stateDefine the scope and state of this authentication handler and the lifecycle in which it can be invoked or activated.
ACTIVE
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.
Type
AuthenticationHandlerStates
Default
ACTIVE
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].subtree-searchWhether subtree searching is allowed.
no default

Whether subtree searching is allowed.

Type
boolean
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].trust-certificatesPath of the trust certificates to use for the SSL connection.
no default

Path of the trust certificates to use for the SSL connection. Ignores keystore-related settings when activated and used.

Type
String
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].trust-managerTrust Manager options.
no default
Trust Manager options. Trust managers are responsible for managing the trust material that is used when making LDAP trust decisions, and for deciding whether credentials presented by a peer should be accepted. Accepted values are:
  • DEFAULT: Enable and force the default JVM trust managers.
  • ANY: Trust any client or server.
Type
String
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].trust-storePath to the keystore used to determine which certificates or certificate authorities should be trusted.
no default
SpEL

Path to the keystore used to determine which certificates or certificate authorities should be trusted. Used when connecting to an LDAP server via LDAPS or startTLS connection. If left blank, the default truststore for the Java runtime is used.

Type
String
Default
none
Defined by
LdapAuthenticationProperties
Supports
Spring Expression Language
cas.authn.ldap[0].trust-store-passwordPassword needed to open the truststore.
no default
SpEL

Password needed to open the truststore.

Type
String
Default
none
Defined by
LdapAuthenticationProperties
Supports
Spring Expression Language
cas.authn.ldap[0].trust-store-typeThe type of trust keystore that determines which certificates or certificate authorities are trusted.
no default

The type of trust keystore that determines which certificates or certificate authorities are trusted. Types depend on underlying java platform, typically PKCS12 or JKS. If left blank, defaults to the default keystore type indicated by the underlying Java platform.

Type
String
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].use-start-tlsWhether TLS should be used and enabled when establishing the connection.
no default

Whether TLS should be used and enabled when establishing the connection.

Type
boolean
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].validate-on-checkoutWhether connections should be validated when loaned out from the pool.
no default

Whether connections should be validated when loaned out from the pool.

Type
boolean
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].validate-periodPeriod at which pool should be validated.
no default
Duration

Period at which pool should be validated.

Type
String
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].validate-periodicallyWhether connections should be validated periodically when the pool is idle.
no default

Whether connections should be validated periodically when the pool is idle.

Type
boolean
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].validate-timeoutPeriod at which validation operations may time out.
no default
Duration

Period at which validation operations may time out.

Type
String
Default
none
Defined by
LdapAuthenticationProperties
cas.authn.ldap[0].validator.attribute-nameAttribute name to use for the compare validator.
objectClass

Attribute name to use for the compare validator.

Type
String
Default
objectClass
Defined by
LdapValidatorProperties
cas.authn.ldap[0].validator.attribute-valueAttribute values to use for the compare validator.
top

Attribute values to use for the compare validator.

Type
String
Default
top
Defined by
LdapValidatorProperties
cas.authn.ldap[0].validator.base-dnBase DN to use for the search request of the search validator.
no default

Base DN to use for the search request of the search validator.

Type
String
Default
none
Defined by
LdapValidatorProperties
cas.authn.ldap[0].validator.dnDN to compare to use for the compare validator.
no default

DN to compare to use for the compare validator.

Type
String
Default
none
Defined by
LdapValidatorProperties
cas.authn.ldap[0].validator.scopeSearch scope to use for the search request of the search validator.
OBJECT

Search scope to use for the search request of the search validator.

Type
String
Default
OBJECT
Defined by
LdapValidatorProperties
cas.authn.ldap[0].validator.search-filterSearch filter to use for the search request of the search validator.
(objectClass=*)

Search filter to use for the search request of the search validator.

Type
String
Default
(objectClass=*)
Defined by
LdapValidatorProperties
cas.authn.ldap[0].validator.typeDetermine the LDAP validator type.
search

Determine the LDAP validator type.

The following LDAP validators can be used to test connection health status:
  • search: Validates a connection is healthy by performing a search operation. Validation is considered successful if the search result size is greater than zero.
  • none: No validation takes place.
  • compare: Validates a connection is healthy by performing a compare operation.
Type
String
Default
search
Defined by
LdapValidatorProperties

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.

Groovy scripting

CAS takes advantage of Apache Groovy in forms of either embedded or external scripts that allow one to, by default, dynamically build constructs, attributes, access strategies and a lot more. To activate the functionality described here, you may need to prepare CAS to support and integrate with Apache Groovy.

Please review this guide to configure your build.

LDAP & Active Directory

LDAP Scriptable Search Filter

LDAP search filters can point to an external Groovy script to dynamically construct the final filter template.

The script itself may be designed as:



1
2
3
4
5
6
7
8
9



import org.ldaptive.*
import org.springframework.context.*

def run(Object[] args) {
    def (filter,parameters,applicationContext,logger) = args

    logger.info("Configuring LDAP filter")
    filter.setFilter("uid=something")
}

The following parameters are passed to the script:

Parameter Description
filter FilterTemplate to be updated by the script and used for the LDAP query.
parameters Map of query parameters which may be used to construct the final filter.
applicationContext Reference to the Spring ApplicationContext reference.
logger The object responsible for issuing log messages such as logger.info(...).

To prepare CAS to support and integrate with Apache Groovy, please review this guide.

Authentication

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

  • A regular expression pattern that is tested against the credential identifier.
  • A fully qualified class name of your own design that looks similar to the below example:


1
2
3
4
5
6
7
8
9



import java.util.function.Predicate;
import org.apereo.cas.authentication.Credential;

public class PredicateExample implements Predicate<Credential> {
    @Override
    public boolean test(final Credential credential) {
        // Examine the credential and return true/false
    }
}
  • Path to an external Groovy script that looks similar to the below example:


1
2
3
4
5
6
7
8
9



import org.apereo.cas.authentication.Credential
import java.util.function.Predicate

class PredicateExample implements Predicate<Credential> {
    @Override
    boolean test(final Credential credential) {
        // test and return result
    }
}

To prepare CAS to support and integrate with Apache Groovy, please review this guide.

Password encoding

If you need to design your own password encoding scheme where the type is specified as a fully qualified Java class name, the structure of the class would be similar to the following:



1
2
3
4
5
6
7
8
9
10
11



package org.example.cas;

import org.springframework.security.crypto.codec.*;
import org.springframework.security.crypto.password.*;

public class MyEncoder extends AbstractPasswordEncoder {
    @Override
    protected byte[] encode(CharSequence rawPassword, byte[] salt) {
        return ...
    }
}

If you need to design your own password encoding scheme where the type is specified as a path to a Groovy script, the structure of the script would be similar to the following:



1
2
3
4
5
6
7
8
9
10
11
12



import java.util.*

byte[] run(final Object... args) {
    def (rawPassword,generatedSalt,logger,applicationContext) = args
    logger.debug("Encoding password...")
    return ...
}

Boolean matches(final Object... args) {
    def (rawPassword,encodedPassword,logger,applicationContext) = args
    logger.debug("Does match or not ?");
    return ...

To prepare CAS to support and integrate with Apache Groovy, please review this guide.

Password policy

Password Policy Strategies

If the password policy strategy is to be handed off to a Groovy script, the outline of the script may be as follows:



1
2
3
4
5
6
7
8
9
10
11
12
13



import java.util.*
import org.ldaptive.auth.*
import org.apereo.cas.*
import org.apereo.cas.authentication.*
import org.apereo.cas.authentication.support.*

List<MessageDescriptor> run(final Object... args) {
    def (response,configuration,logger,applicationContext) = args
    logger.info("Handling password policy [{}] via ${configuration.getAccountStateHandler()}", response)

    def accountStateHandler = configuration.getAccountStateHandler()
    return accountStateHandler.handle(response, configuration)
}

The parameters passed are as follows:

Parameter Description
response The LDAP authentication response of type org.ldaptive.auth.AuthenticationResponse
configuration The LDAP password policy configuration carrying the account state handler defined.
logger The object responsible for issuing log messages such as logger.info(...).
applicationContext The Spring ApplicationContext that allows one to interact with the runtime.

To prepare CAS to support and integrate with Apache Groovy, please review this guide.

Principal transformation

Authentication handlers that generally deal with username-password credentials can be configured to transform the user id prior to executing the authentication sequence. Each authentication strategy in CAS provides settings to properly transform the principal. Refer to the relevant settings for the authentication strategy at hand to learn more.

Authentication handlers as part of principal transformation may also be provided a path to a Groovy script to transform the provided username. The outline of the script may take on the following form:



1
2
3
4



String run(final Object... args) {
    def (providedUsername,logger) = args
    return providedUsername.concat("SomethingElse")
}

To prepare CAS to support and integrate with Apache Groovy, please review this guide.

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.

Password Policy Enforcement

To learn how to enforce a password policy for LDAP, please review this guide.

Password Synchronization

You may also be interested in synchronizing account passwords with one or more LDAP servers. To learn more, please review this guide.

Multitenancy

Configuration settings for LDAP authentication can be specified in a multitenant environment. Please review this guide for more information.

Troubleshooting

To enable additional logging, modify the logging configuration file to add the following:



1
2
3
4



<Logger name="org.ldaptive" level="debug" additivity="false">
    <AppenderRef ref="casConsole"/>
    <AppenderRef ref="casFile"/>
</Logger>