WORKERS AHEAD!
You are viewing the development documentation for the Apereo CAS server. The functionality presented here is not officially released yet. This is a work in progress and will be continually updated as development moves forward. You are most encouraged to test the changes presented.
To view the documentation for a specific Apereo CAS server release, please choose an appropriate version. The release schedule is available here.LDAP Service Registry
Service registry implementation which stores the services in a LDAP Directory
and attempts to map service records to LDAP entries in order to configure
settings for retrieval, search and persistence of service definitions. By default,
entries are assigned the objectclass
that is casRegisteredService
attribute and are looked up by the uid
attribute.
Support is enabled by adding the following module into the overlay:
implementation "org.apereo.cas:cas-server-support-ldap-service-registry:${project.'cas.version'}"
<dependency>
<groupId>org.apereo.cas</groupId>
<artifactId>cas-server-support-ldap-service-registry</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-service-registry"
}
Configuration
The default mapper has support for the following optional items:
Field | Default Value |
---|---|
objectClass |
casRegisteredService |
serviceDefinitionAttribute |
description |
idAttribute |
uid |
Service definitions are by default stored inside the serviceDefinitionAttribute
attribute as
JSON objects. The format and syntax of the JSON is identical to that of
JSON Service Registry. That’s all, as far as the schema goes.
The following settings and properties are available from the CAS configuration catalog:
cas.service-registry.ldap.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: |
cas.service-registry.ldap.bind-credential=
The bind credential to use when connecting to LDAP. |
cas.service-registry.ldap.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:
|
cas.service-registry.ldap.ldap-url=
The LDAP url to the server. More than one may be specified, separated by space and/or comma. |
cas.service-registry.ldap.search-filter=
User filter to use for searching. Syntax is |
cas.service-registry.ldap.allow-multiple-dns=false
Whether search/query results are allowed to match on multiple DNs, or whether a single unique DN is expected for the result. |
cas.service-registry.ldap.allow-multiple-entries=false
Set if multiple Entries are allowed. |
cas.service-registry.ldap.binary-attributes=
Indicate the collection of attributes that are to be tagged and processed as binary attributes by the underlying search resolver. |
cas.service-registry.ldap.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 |
cas.service-registry.ldap.connect-timeout=PT5S
Sets the maximum amount of time that connects will block. |
cas.service-registry.ldap.connection-strategy=
If multiple URLs are provided as the ldapURL this describes how each URL will be processed.
|
cas.service-registry.ldap.disable-pooling=false
Whether to use a pooled connection factory in components. |
cas.service-registry.ldap.fail-fast=true
Attempt to populate the connection pool early on startup and fail quickly if something goes wrong. |
cas.service-registry.ldap.follow-referrals=true
Set if search referrals should be followed. |
cas.service-registry.ldap.hostname-verifier=
Hostname verification options. Available values are as follows:
|
cas.service-registry.ldap.id-attribute=uid
ID attribute used for the registered service entry in LDAP to keep track of the service numeric identifier. |
cas.service-registry.ldap.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. |
cas.service-registry.ldap.keystore=
Path to the keystore used for SSL connections. Typically contains SSL certificates for the LDAP server. |
cas.service-registry.ldap.keystore-password=
Keystore password. |
cas.service-registry.ldap.keystore-type=
The type of keystore. |
cas.service-registry.ldap.load-filter=(objectClass=%s)
The load filter used to load entries by the |
cas.service-registry.ldap.max-pool-size=10
Maximum LDAP connection pool size which the pool can use to grow. |
cas.service-registry.ldap.min-pool-size=3
Minimum LDAP connection pool size. Size the pool should be initialized to and pruned to |
cas.service-registry.ldap.name=
Name of the LDAP handler. |
cas.service-registry.ldap.object-class=casRegisteredService
Object class used for the registered service entry in LDAP. |
cas.service-registry.ldap.page-size=0
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. |
cas.service-registry.ldap.pool-passivator=BIND
You may receive unexpected LDAP failures, when CAS is configured to authenticate using
|
cas.service-registry.ldap.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. |
cas.service-registry.ldap.response-timeout=PT5S
Duration of time to wait for responses. |
cas.service-registry.ldap.sasl-authorization-id=
SASL authorization id. |
cas.service-registry.ldap.sasl-mechanism=
The SASL mechanism. |
cas.service-registry.ldap.sasl-mutual-auth=
SASL mutual auth is enabled? |
cas.service-registry.ldap.sasl-quality-of-protection=
SASL quality of protected. |
cas.service-registry.ldap.sasl-realm=
The SASL realm. |
cas.service-registry.ldap.sasl-security-strength=
SASL security strength. |
cas.service-registry.ldap.search-entry-handlers=
Search handlers. |
cas.service-registry.ldap.service-definition-attribute=description
Service definition attribute used for the registered service entry in LDAP to keep a representation of the service body. |
cas.service-registry.ldap.subtree-search=true
Whether subtree searching is allowed. |
cas.service-registry.ldap.trust-certificates=
Path of the trust certificates to use for the SSL connection. Ignores keystore-related settings when activated and used. |
cas.service-registry.ldap.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: *
|
cas.service-registry.ldap.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. |
cas.service-registry.ldap.trust-store-password=
Password needed to open the truststore. |
cas.service-registry.ldap.trust-store-type=
The type of trust keystore that determines which certificates or certificate authorities are trusted. Types depend on underlying java platform, typically |
cas.service-registry.ldap.use-start-tls=false
Whether TLS should be used and enabled when establishing the connection. |
cas.service-registry.ldap.validate-on-checkout=true
Whether connections should be validated when loaned out from the pool. |
cas.service-registry.ldap.validate-period=PT5M
Period at which pool should be validated. |
cas.service-registry.ldap.validate-periodically=true
Whether connections should be validated periodically when the pool is idle. |
cas.service-registry.ldap.validate-timeout=PT5S
Period at which validation operations may time out. |
cas.service-registry.ldap.search-entry-handlers[0].case-change.attribute-name-case-change=
The Attribute name case change. |
cas.service-registry.ldap.search-entry-handlers[0].case-change.attribute-names=
The Attribute names. |
cas.service-registry.ldap.search-entry-handlers[0].case-change.attribute-value-case-change=
The Attribute value case change. |
cas.service-registry.ldap.search-entry-handlers[0].case-change.dn-case-change=
The Dn case change. |
cas.service-registry.ldap.search-entry-handlers[0].dn-attribute.add-if-exists=
The Add if exists. |
cas.service-registry.ldap.search-entry-handlers[0].dn-attribute.dn-attribute-name=entryDN
The Dn attribute name. |
cas.service-registry.ldap.search-entry-handlers[0].merge-attribute.attribute-names=
The Attribute names. |
cas.service-registry.ldap.search-entry-handlers[0].merge-attribute.merge-attribute-name=
The Merge attribute name. |
cas.service-registry.ldap.search-entry-handlers[0].primary-group-id.base-dn=
The Base dn. |
cas.service-registry.ldap.search-entry-handlers[0].primary-group-id.group-filter=(&(objectClass=group)(objectSid={0}))
The Group filter. |
cas.service-registry.ldap.search-entry-handlers[0].recursive.merge-attributes=
The Merge attributes. |
cas.service-registry.ldap.search-entry-handlers[0].recursive.search-attribute=
The Search attribute. |
cas.service-registry.ldap.search-entry-handlers[0].type=
The type of search entry handler to choose. Available values are as follows:
|
cas.service-registry.ldap.validator.attribute-name=objectClass
Attribute name to use for the compare validator. |
cas.service-registry.ldap.validator.attribute-value=top
Attribute values to use for the compare validator. |
cas.service-registry.ldap.validator.base-dn=
Base DN to use for the search request of the search validator. |
cas.service-registry.ldap.validator.dn=
DN to compare to use for the compare validator. |
cas.service-registry.ldap.validator.scope=OBJECT
Search scope to use for the search request of the search validator. |
cas.service-registry.ldap.validator.search-filter=(objectClass=*)
Search filter to use for the search request of the search validator. |
cas.service-registry.ldap.validator.type=search
Determine the LDAP validator type. The following LDAP validators can be used to test connection health status:
|