APEREO CASDocumentation

Enterprise Authentication for All Earthlings and Beyond

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

Password Management - LDAP

The account password and security questions may be stored inside an LDAP server.

LDAP support is enabled by including the following dependencies in the WAR overlay:



1
2
3
4
5



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





1



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

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

cas.authn.pm.ldap[0].account-locked-attributeName of LDAP attribute that represents the account locked status.
pwdLockout
Required

Name of LDAP attribute that represents the account locked status. The value of the attribute is typically set to "true" if the account is ever updated to indicated a locked status. For Active Directory, this attribute might be called lockoutTime.

Type
String
Default
pwdLockout
Defined by
LdapPasswordManagementProperties
cas.authn.pm.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
LdapPasswordManagementProperties
cas.authn.pm.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
LdapPasswordManagementProperties
cas.authn.pm.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
LdapPasswordManagementProperties
cas.authn.pm.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
LdapPasswordManagementProperties
cas.authn.pm.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.pm.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
LdapPasswordManagementProperties
cas.authn.pm.ldap[0].typeThe specific variant of LDAP based on which update operations will be constructed.
AD
Required
The specific variant of LDAP based on which update operations will be constructed. Accepted values are: *
  • AD
  • GENERIC
  • FreeIPA
  • EDirectory
Type
LdapType
Default
AD
Defined by
LdapPasswordManagementProperties
cas.authn.pm.ldap[0].username-attributeUsername attribute required by LDAP.
uid
Required

Username attribute required by LDAP.

Type
String
Default
uid
Defined by
LdapPasswordManagementProperties
cas.authn.pm.ldapManage account passwords in LDAP.
no default

Manage account passwords in LDAP.

Type
List<LdapPasswordManagementProperties>
Default
none
Defined by
PasswordManagementProperties
cas.authn.pm.ldap[0].account-unlocked-attribute-valuesWhen CAS is about to unlock the user account, it will use the #accountLockedAttribute setting to locate the appropriate attribute for the user entry.
[FALSE]

When CAS is about to unlock the user account, it will use the #accountLockedAttribute setting to locate the appropriate attribute for the user entry. This attribute will then be assigned the value(s) defined here to unlock the account.

For Active Directory and in scenarios where #accountLockedAttribute is set to lockoutTime, this value might be set to zero. A value of zero means that the account is not currently locked out.

Note that the value defined here may be treated as case sensitive by the LDAP server.

Type
String
Default
[FALSE]
Defined by
LdapPasswordManagementProperties
cas.authn.pm.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
LdapPasswordManagementProperties
cas.authn.pm.ldap[0].allow-multiple-entriesSet if multiple Entries are allowed.
no default

Set if multiple Entries are allowed.

Type
boolean
Default
none
Defined by
LdapPasswordManagementProperties
cas.authn.pm.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
LdapPasswordManagementProperties
cas.authn.pm.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
LdapPasswordManagementProperties
cas.authn.pm.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
LdapPasswordManagementProperties
cas.authn.pm.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
LdapPasswordManagementProperties
cas.authn.pm.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
LdapPasswordManagementProperties
cas.authn.pm.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
LdapPasswordManagementProperties
cas.authn.pm.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
LdapPasswordManagementProperties
cas.authn.pm.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
LdapPasswordManagementProperties
cas.authn.pm.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
LdapPasswordManagementProperties
cas.authn.pm.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
LdapPasswordManagementProperties
Supports
Spring Expression Language
cas.authn.pm.ldap[0].keystore-passwordKeystore password.
no default
SpEL

Keystore password.

Type
String
Default
none
Defined by
LdapPasswordManagementProperties
Supports
Spring Expression Language
cas.authn.pm.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
LdapPasswordManagementProperties
cas.authn.pm.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
LdapPasswordManagementProperties
cas.authn.pm.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
LdapPasswordManagementProperties
cas.authn.pm.ldap[0].nameName of the LDAP handler.
no default

Name of the LDAP handler.

Type
String
Default
none
Defined by
LdapPasswordManagementProperties
cas.authn.pm.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
LdapPasswordManagementProperties
cas.authn.pm.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
LdapPasswordManagementProperties
cas.authn.pm.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.pm.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.pm.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.pm.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.pm.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.pm.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
LdapPasswordManagementProperties
cas.authn.pm.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
LdapPasswordManagementProperties
cas.authn.pm.ldap[0].sasl-authorization-idSASL authorization id.
no default

SASL authorization id.

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

The SASL mechanism.

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

Whether SASL mutual authentication is enabled.

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

SASL quality of protected.

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

The SASL realm.

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

SASL security strength.

Type
String
Default
none
Defined by
LdapPasswordManagementProperties
cas.authn.pm.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.pm.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.pm.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.pm.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.pm.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.pm.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.pm.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.pm.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.pm.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.pm.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.pm.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.pm.ldap[0].search-entry-handlers.recursive.search-attributeThe Search attribute.
no default

The Search attribute.

Type
String
Default
none
Defined by
RecursiveSearchEntryHandlersProperties
cas.authn.pm.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.pm.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.pm.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.pm.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.pm.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.pm.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.pm.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.pm.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.pm.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.pm.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.pm.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.pm.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.pm.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.pm.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.pm.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.pm.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.pm.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.pm.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.pm.ldap[0].security-questions-attributesCollection of attribute names that indicate security questions answers.
no default

Collection of attribute names that indicate security questions answers. This is done via a key-value structure where the key is the attribute name for the security question and the value is the attribute name for the answer linked to the question.

Type
Map<String, String>
Default
none
Defined by
LdapPasswordManagementProperties
cas.authn.pm.ldap[0].subtree-searchWhether subtree searching is allowed.
no default

Whether subtree searching is allowed.

Type
boolean
Default
none
Defined by
LdapPasswordManagementProperties
cas.authn.pm.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
LdapPasswordManagementProperties
cas.authn.pm.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
LdapPasswordManagementProperties
cas.authn.pm.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
LdapPasswordManagementProperties
Supports
Spring Expression Language
cas.authn.pm.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
LdapPasswordManagementProperties
Supports
Spring Expression Language
cas.authn.pm.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
LdapPasswordManagementProperties
cas.authn.pm.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
LdapPasswordManagementProperties
cas.authn.pm.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
LdapPasswordManagementProperties
cas.authn.pm.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
LdapPasswordManagementProperties
cas.authn.pm.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
LdapPasswordManagementProperties
cas.authn.pm.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
LdapPasswordManagementProperties
cas.authn.pm.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.pm.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.pm.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.pm.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.pm.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.pm.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.pm.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.

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.