Password Synchronization

CAs presents the ability to synchronize and update the account password in a variety of destinations as part of the authentication event. If the authentication attempt is successful, CAS will attempt to capture the provided password and update destinations that are specified in CAS settings. Failing to synchronize an account password generally produces errors in the logs and the event is not considered a catastrophic failure.

Configuration

Allow the user to synchronize account password to a variety of destinations in-place.

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
10
11
12
import org.ldaptive.*
import org.springframework.context.*

def run(Object[] args) {
    def filter = (FilterTemplate) args[0]
    def parameters = (Map) args[1]
    def applicationContext = (ApplicationContext) args[2]
    def logger = args[3]

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

LDAP

Synchronize account passwords with one or more LDAP servers. Support is enabled by including the following dependencies in the WAR overlay:

implementation "org.apereo.cas:cas-server-support-ldap:${project.'cas.version'}"
<dependency>
  <groupId>org.apereo.cas</groupId>
  <artifactId>cas-server-support-ldap</artifactId>
  <version>${cas.version}</version>
</dependency>
dependencyManagement {
  imports {
    mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
  }
}

dependencies {  
  implementation "org.apereo.cas:cas-server-support-ldap"
}

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

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

  • cas.authn.password-sync.ldap[0].base-dn=
  • 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.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].bind-credential=
  • The bind credential to use when connecting to LDAP.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].bind-dn=
  • 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.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].ldap-url=
  • The LDAP url to the server. More than one may be specified, separated by space and/or comma.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].search-filter=
  • 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.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

    The configuration settings listed below are tagged as Optional in the CAS configuration metadata. This flag indicates that the presence of the setting is not immediately necessary in the end-user CAS configuration, because a default value is assigned or the activation of the feature is not conditionally controlled by the setting value.

  • cas.authn.password-sync.ldap=
  • Options for password sync via LDAP.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.PasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].allow-multiple-dns=
  • Whether search/query results are allowed to match on multiple DNs, or whether a single unique DN is expected for the result.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].allow-multiple-entries=
  • Set if multiple Entries are allowed.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].binary-attributes=
  • Indicate the collection of attributes that are to be tagged and processed as binary attributes by the underlying search resolver.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].block-wait-time=PT3S
  • 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

    This settings supports the java.time.Duration syntax [?].

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].connect-timeout=PT5S
  • Sets the maximum amount of time that connects will block.

    This settings supports the java.time.Duration syntax [?].

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].connection-strategy=
  • 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.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].disable-pooling=
  • Whether to use a pooled connection factory in components.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].enabled=
  • Whether or not password sync should be enabled for this ldap instance.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].fail-fast=true
  • Attempt to populate the connection pool early on startup and fail quickly if something goes wrong.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].follow-referrals=true
  • Set if search referrals should be followed.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].hostname-verifier=DEFAULT
  • Hostname verification options. Available values are as follows:

    • DEFAULT: Default option, forcing verification.
    • ANY: Skip hostname verification and allow all.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].idle-time=PT10M
  • 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.

    This settings supports the java.time.Duration syntax [?].

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].keystore=
  • Path to the keystore used for SSL connections. Typically contains SSL certificates for the LDAP server.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].keystore-password=
  • Keystore password.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].keystore-type=
  • The type of keystore. PKCS12 or JKS. If left blank, defaults to the default keystore type indicated by the underlying Java platform.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].max-pool-size=10
  • Maximum LDAP connection pool size which the pool can use to grow.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].min-pool-size=3
  • Minimum LDAP connection pool size. Size the pool should be initialized to and pruned to

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].name=
  • Name of the LDAP handler.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].page-size=
  • 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.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].pool-passivator=BIND
  • 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.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].prune-period=PT2H
  • 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.

    This settings supports the java.time.Duration syntax [?].

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].response-timeout=PT5S
  • Duration of time to wait for responses.

    This settings supports the java.time.Duration syntax [?].

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].sasl-authorization-id=
  • SASL authorization id.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].sasl-mechanism=
  • The SASL mechanism.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].sasl-mutual-auth=
  • SASL mutual auth is enabled?

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].sasl-quality-of-protection=
  • SASL quality of protected.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].sasl-realm=
  • The SASL realm.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].sasl-security-strength=
  • SASL security strength.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].search-entry-handlers=
  • Search handlers.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].subtree-search=true
  • Whether subtree searching is allowed.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].trust-certificates=
  • Path of the trust certificates to use for the SSL connection. Ignores keystore-related settings when activated and used.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].trust-manager=
  • 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.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].trust-store=
  • 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.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].trust-store-password=
  • Password needed to open the truststore.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].trust-store-type=
  • 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.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].use-start-tls=
  • Whether TLS should be used and enabled when establishing the connection.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].validate-on-checkout=true
  • Whether connections should be validated when loaned out from the pool.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].validate-period=PT5M
  • Period at which pool should be validated.

    This settings supports the java.time.Duration syntax [?].

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].validate-periodically=true
  • Whether connections should be validated periodically when the pool is idle.

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].validate-timeout=PT5S
  • Period at which validation operations may time out.

    This settings supports the java.time.Duration syntax [?].

    This setting is owned by org.apereo.cas.configuration.model.core.authentication.passwordsync.LdapPasswordSynchronizationProperties.

  • cas.authn.password-sync.ldap[0].validator.attribute-name=objectClass
  • Attribute name to use for the compare validator.

    This setting is owned by org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.

  • cas.authn.password-sync.ldap[0].validator.attribute-value=top
  • Attribute values to use for the compare validator.

    This setting is owned by org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.

  • cas.authn.password-sync.ldap[0].validator.base-dn=EMPTY
  • Base DN to use for the search request of the search validator.

    This setting is owned by org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.

  • cas.authn.password-sync.ldap[0].validator.dn=EMPTY
  • DN to compare to use for the compare validator.

    This setting is owned by org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.

  • cas.authn.password-sync.ldap[0].validator.scope=OBJECT
  • Search scope to use for the search request of the search validator.

    This setting is owned by org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.

  • cas.authn.password-sync.ldap[0].validator.search-filter=(objectClass=*)
  • Search filter to use for the search request of the search validator.

    This setting is owned by org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.

  • cas.authn.password-sync.ldap[0].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.

    This setting is owned by org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties.