LDAP Attribute Resolution
The following configuration describes how to fetch and retrieve attributes from LDAP attribute repositories.
The following settings and properties are available from the CAS configuration catalog:
cas.authn.attribute-repository.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:
|
cas.authn.attribute-repository.ldap[0].bind-credential=
The bind credential to use when connecting to LDAP.
|
cas.authn.attribute-repository.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:
|
cas.authn.attribute-repository.ldap[0].ldap-url=
The LDAP url to the server. More than one may be specified, separated by space and/or comma.
|
cas.authn.attribute-repository.ldap[0].search-filter=
User filter to use for searching.
Syntax is file:/path/to/GroovyScript.groovy
to fully build the final filter template dynamically.
|
cas.authn.attribute-repository.ldap=
Retrieve attributes from multiple LDAP servers.
|
cas.authn.attribute-repository.ldap[0].search-entry-handlers.case-change.attribute-name-case-change=
The Attribute name case change.
|
cas.authn.attribute-repository.ldap[0].search-entry-handlers.case-change.attribute-names=
The Attribute names.
|
cas.authn.attribute-repository.ldap[0].search-entry-handlers.case-change.attribute-value-case-change=
The Attribute value case change.
|
cas.authn.attribute-repository.ldap[0].search-entry-handlers.case-change.dn-case-change=
The Dn case change.
|
cas.authn.attribute-repository.ldap[0].search-entry-handlers.dn-attribute.add-if-exists=
The Add if exists.
|
cas.authn.attribute-repository.ldap[0].search-entry-handlers.dn-attribute.dn-attribute-name=entryDN
The Dn attribute name.
|
cas.authn.attribute-repository.ldap[0].search-entry-handlers.merge-attribute.attribute-names=
The Attribute names.
|
cas.authn.attribute-repository.ldap[0].search-entry-handlers.merge-attribute.merge-attribute-name=
The Merge attribute name.
|
cas.authn.attribute-repository.ldap[0].search-entry-handlers.primary-group-id.base-dn=
The Base dn.
|
cas.authn.attribute-repository.ldap[0].search-entry-handlers.primary-group-id.group-filter=(&(objectClass=group)(objectSid={0}))
The Group filter.
|
cas.authn.attribute-repository.ldap[0].search-entry-handlers.recursive.merge-attributes=
The Merge attributes.
|
cas.authn.attribute-repository.ldap[0].search-entry-handlers.recursive.search-attribute=
The Search attribute.
|
cas.authn.attribute-repository.ldap[0].search-entry-handlers.search-referral.limit=10
The default referral limit.
|
cas.authn.attribute-repository.ldap[0].search-entry-handlers.search-result.limit=10
The default referral limit.
|
cas.authn.attribute-repository.ldap[0].search-entry-handlers.type=
The type of search entry handler to choose. Available values are as follows:
|
cas.authn.attribute-repository.ldap[0].validator.attribute-name=objectClass
Attribute name to use for the compare validator.
|
cas.authn.attribute-repository.ldap[0].validator.attribute-value=top
Attribute values to use for the compare validator.
|
cas.authn.attribute-repository.ldap[0].validator.base-dn=EMPTY
Base DN to use for the search request of the search validator.
|
cas.authn.attribute-repository.ldap[0].validator.dn=EMPTY
DN to compare to use for the compare validator.
|
cas.authn.attribute-repository.ldap[0].validator.scope=OBJECT
Search scope to use for the search request of the search validator.
|
cas.authn.attribute-repository.ldap[0].validator.search-filter=(objectClass=*)
Search filter to use for the search request of the search validator.
|
cas.authn.attribute-repository.ldap[0].validator.type=search
Determine the LDAP validator type. The following LDAP validators can be used to test connection health status:
|
cas.authn.attribute-repository.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.
|
cas.authn.attribute-repository.ldap[0].allow-multiple-entries=
Set if multiple Entries are allowed.
|
cas.authn.attribute-repository.ldap[0].attributes=
Map of attributes to fetch from the source. Attributes are defined using a key-value structure where CAS allows the attribute name/key to be renamed virtually to a different attribute. The key is the attribute fetched from the data source and the value is the attribute name CAS should use for virtual renames. Attributes may be allowed to be virtually renamed and remapped. The key in the attribute map is the original attribute, and the value should be the virtually-renamed attribute. To fetch and resolve attributes that carry tags/options, consider tagging the mapped attribute as such:affiliation=affiliation .
|
cas.authn.attribute-repository.ldap[0].binary-attributes=
Indicate the collection of attributes that are to be tagged and processed as binary attributes by the underlying search resolver.
|
cas.authn.attribute-repository.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
|
cas.authn.attribute-repository.ldap[0].connect-timeout=PT5S
Sets the maximum amount of time that connects will block. This settings supports the
|
cas.authn.attribute-repository.ldap[0].connection-strategy=
If multiple URLs are provided as the ldapURL this describes how each URL will be processed.
|
cas.authn.attribute-repository.ldap[0].disable-pooling=
Whether to use a pooled connection factory in components.
|
cas.authn.attribute-repository.ldap[0].fail-fast=true
Attempt to populate the connection pool early on startup and fail quickly if something goes wrong.
|
cas.authn.attribute-repository.ldap[0].follow-referrals=true
Set if search referrals should be followed.
|
cas.authn.attribute-repository.ldap[0].hostname-verifier=DEFAULT
Hostname verification options. Available values are as follows:
|
cas.authn.attribute-repository.ldap[0].id=
A value can be assigned to this field to uniquely identify this resolver.
|
cas.authn.attribute-repository.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
|
cas.authn.attribute-repository.ldap[0].keystore=
Path to the keystore used for SSL connections. Typically contains SSL certificates for the LDAP server. This setting supports the Spring Expression Language.
|
cas.authn.attribute-repository.ldap[0].keystore-password=
Keystore password. This setting supports the Spring Expression Language.
|
cas.authn.attribute-repository.ldap[0].keystore-type=
The type of keystore.
|
cas.authn.attribute-repository.ldap[0].max-pool-size=10
Maximum LDAP connection pool size which the pool can use to grow.
|
cas.authn.attribute-repository.ldap[0].min-pool-size=3
Minimum LDAP connection pool size. Size the pool should be initialized to and pruned to
|
cas.authn.attribute-repository.ldap[0].name=
Name of the LDAP handler.
|
cas.authn.attribute-repository.ldap[0].order=
The order of this attribute repository in the chain of repositories. Can be used to explicitly position this source in chain and affects merging strategies.
|
cas.authn.attribute-repository.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.
|
cas.authn.attribute-repository.ldap[0].pool-passivator=BIND
You may receive unexpected LDAP failures, when CAS is configured to authenticate
using
|
cas.authn.attribute-repository.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
|
cas.authn.attribute-repository.ldap[0].query-attributes=
Define a
|
cas.authn.attribute-repository.ldap[0].response-timeout=PT5S
Duration of time to wait for responses. This settings supports the
|
cas.authn.attribute-repository.ldap[0].sasl-authorization-id=
SASL authorization id.
|
cas.authn.attribute-repository.ldap[0].sasl-mechanism=
The SASL mechanism.
|
cas.authn.attribute-repository.ldap[0].sasl-mutual-auth=
SASL mutual auth is enabled?
|
cas.authn.attribute-repository.ldap[0].sasl-quality-of-protection=
SASL quality of protected.
|
cas.authn.attribute-repository.ldap[0].sasl-realm=
The SASL realm.
|
cas.authn.attribute-repository.ldap[0].sasl-security-strength=
SASL security strength.
|
cas.authn.attribute-repository.ldap[0].state=ACTIVE
Whether attribute resolution based on this source is enabled.
|
cas.authn.attribute-repository.ldap[0].subtree-search=true
Whether subtree searching is allowed.
|
cas.authn.attribute-repository.ldap[0].trust-certificates=
Path of the trust certificates to use for the SSL connection. Ignores keystore-related settings when activated and used.
|
cas.authn.attribute-repository.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: *
|
cas.authn.attribute-repository.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 supports the Spring Expression Language.
|
cas.authn.attribute-repository.ldap[0].trust-store-password=
Password needed to open the truststore. This setting supports the Spring Expression Language.
|
cas.authn.attribute-repository.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
|
cas.authn.attribute-repository.ldap[0].use-all-query-attributes=true
Whether all existing attributes should be passed down to the query builder map and be used in the construction of the filter.
|
cas.authn.attribute-repository.ldap[0].use-start-tls=
Whether TLS should be used and enabled when establishing the connection.
|
cas.authn.attribute-repository.ldap[0].validate-on-checkout=true
Whether connections should be validated when loaned out from the pool.
|
cas.authn.attribute-repository.ldap[0].validate-period=PT5M
Period at which pool should be validated. This settings supports the
|
cas.authn.attribute-repository.ldap[0].validate-periodically=true
Whether connections should be validated periodically when the pool is idle.
|
cas.authn.attribute-repository.ldap[0].validate-timeout=PT5S
Period at which validation operations may time out. This settings supports the
|
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(...) . |
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.
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, specially if defined CAS settings cannot be
recognized or validated by the configuration schema. The validation process is on by default and can be skipped on startup using a special system
property SKIP_CONFIG_VALIDATION
that should be set to true
. 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.