LDAPConnector

Namespace: urn:mace:shibboleth:2.0:resolver
Schema: http://shibboleth.net/schema/idp/shibboleth-attribute-resolver.xsd

1 Overview
2 General Configuration
- 2.1 TLS Validation Configuration
3 Examples
4 Reference

Overview

The LDAPDirectory data connector generates one or more attributes based on a query to an LDAP directory.

The underlying library used for this is called ldaptive, and many of the more advanced options are usable only by referring to its documentation, but most deployers should be able to make to do with the information we supply.

General Configuration

The IdP ships with an example configuration file (conf/examples/attribute-resolver-ldap.xml), that demonstrates property-driven attribute resolution, using the properties defined in ldap.properties, much of which can be shared with the LDAP Authentication Configuration for the common case of a single LDAP directory used for both authentication and attributes. You can freely mix use of properties with explicit settings.

If execution of the query returns multiple results, these are merged by default.

The following properties are demonstrated. They take their defaults from the values of the similarly-named authentication properties, but can be explicitly set to split them off as needed.

Property	Type	Default Authn Property	Function

Property	Type	Default Authn Property	Function
idp.attribute.resolver.LDAP.ldapURL	URL	idp.authn.LDAP.ldapURL	Connection URL for the LDAP directory
idp.attribute.resolver.LDAP.baseDN	String	idp.authn.LDAP.baseDN	Base DN to search against,
idp.attribute.resolver.LDAP.bindDN	String	idp.authn.LDAP.bindDN	DN to bind as before performing the search
idp.attribute.resolver.LDAP.bindDNCredential	String	idp.authn.LDAP.bindDNCredential	Password to bind with before performing the search
idp.attribute.resolver.LDAP.useStartTLS	Boolean	idp.authn.LDAP.useStartTLS (defaults true)	Whether StartTLS should be used immediately after connecting to the LDAP
idp.attribute.resolver.LDAP.trustCertificates	Resource	idp.authn.LDAP.trustCertificates	A resource to load trust anchors from, usually a local file in %{idp.home}/credentials
idp.attribute.resolver.LDAP.connectTimeout	Duration	idp.authn.LDAP.connectTimeout (defaults PT3S)	Connection timeout in milliseconds
idp.attribute.resolver.LDAP.responseTimeout	Duration	idp.authn.LDAP.responseTimeout (defaults PT3S)	Time to wait for an LDAP response (Applies to every request except startTLS)
idp.attribute.resolver.LDAP.connectionStrategy	Enumeration	ACTIVE_PASSIVE	Connection strategy to use when multiple URLs are supplied, one of ACTIVE_PASSIVE, ROUND_ROBIN, RANDOM

TLS Validation Configuration

Assuming either LDAP-over-TLS (ldaps) or StartTLS are used, you MUST configure the rules for validating the LDAP server's TLS key within the connector.

There are generally two ways to do this:

Reference a CA (Certificate Authority) that has signed the certificate chain presented by the LDAP server.
Reference the LDAP server's certificate explicitly.

The latter provides better security but likely will require constant updating and coordination with the LDAP server's operational staff unless it relies on a longer-lived certificate.

You may configure multiple certificates by concatenating PEM formatted certificates together.

You reference the certificate(s) you choose to trust by setting the trustFile XML attribute inside the <DataConnector> element, and the example below passes that through to a property you can configure separately, but that's purely a matter of style.

Note that this is distinct from configuring the IdP to authenticate itself to the LDAP server with a certificate. That relies on a different set of options (authKey, authCert).

Examples

<DataConnector id="myLDAP" xsi:type="LDAPDirectory"
    ldapURL="%{idp.attribute.resolver.LDAP.ldapURL}" 
    baseDN="%{idp.attribute.resolver.LDAP.baseDN}" 
    principal="%{idp.attribute.resolver.LDAP.bindDN}"
    principalCredential="%{idp.attribute.resolver.LDAP.bindDNCredential}"
	trustFile="%{idp.attribute.resolver.LDAP.trustCertificates}"
	useStartTLS="%{idp.attribute.resolver.LDAP.useStartTLS:true}"
    noResultIsError="%{idp.attribute.resolver.LDAP.noResultsIsError:false}"
    multipleResultsIsError="%{idp.attribute.resolver.LDAP.multipleResultsIsError:true}">
    <FilterTemplate>
        <![CDATA[
            %{idp.attribute.resolver.LDAP.searchFilter}
        ]]>
    </FilterTemplate>
    <StartTLSAuthenticationCredential xsi:type="security:X509Filesystem" xmlns:security="urn:mace:shibboleth:2.0:security" id="IdPtoLDAPCredential">
        <security:PrivateKey>%{idp.attribute.resolver.LDAP.authenticationKey}</security:PrivateKey>
        <security:Certificate>%{idp.attribute.resolver.LDAP.authenticationCertificate}</security:Certificate>
    </StartTLSAuthenticationCredential>
    <ConnectionPool
        minPoolSize="%{idp.pool.LDAP.minSize}"
        maxPoolSize="%{idp.pool.LDAP.maxSize}"
        blockWaitTime="%{idp.pool.LDAP.blockWaitTime}"
        expirationTime="%{idp.pool.LDAP.expirationTime}"
        validatePeriodically="%{idp.pool.LDAP.validatePeriodically}"
        validateTimerPeriod="%{idp.pool.LDAP.validatePeriod}"
        validateDN="%{idp.pool.LDAP.validateDN}"
        validateFilter="%{idp.pool.LDAP.validateFilter}"/>
    <ResultCache
        elementTimeToLive="%{idp.cache.LDAP.timeToLive}"
        maximumCachedElements="%{idp.cache.LDAP.cacheSize}"/>
</DataConnector>

Reference

Name	Type	Default	Description

Name	Type	Default	Description
ldapURL	Space-delimited list of URLs		URL(s) to the LDAP server. Each listed URL is tried according to the `connectionStrategy`.
baseDN	String		Base DN from which the LDAP search will be executed
principal	String		Username (service DN) that the connector will use to bind to the LDAP directory
principalCredential	String		Password used to authenticate as the principal (service DN)
lowercaseAttributeNames	Boolean	false	Whether all attribute IDs from the LDAP should be lower-cased. This can be important since Shibboleth attribute IDs are case-sensitive while LDAP attribute IDs are not.
trustFile	File pathname		Path to a file containing the X.509 trust information to use when connecting to the directory over LDAPS or startTLS. Replaces the deprecated use of `<StartTLSTrustCredential>`
failFastInitialize	Boolean	false	Whether a failure when verifying the LDAP server's availability during startup is fatal (stops the Attribute Resolver service from starting)
connectTimeout	Duration	PT3S	Time to wait for a connection to be established
responseTimeout	Duration	PT3S	Time to wait for responses (Applies to every request except startTLS)
startTLSResponseTimeout	Duration	PT3S	Time to wait for startTLS responses.
autoReconnect	Boolean	true	Whether lost connections should be automatically reopened.
reconnectTimeout	Duration	PT10S	Time to wait for a connection to reconnect.
searchTimeLimit	Duration	PT3S	Length of time that a search operation should execute; a value of 0 means execute indefinitely; when time limit arrives the result will contain any entires returned up to that point
maxResultSize	Integer	1	Maximum number of entries to allow in the search result; a value of 0 means includes all entries. Exceeding this value will result in a failure of the connector.
noResultIsError	Boolean	false	Whether an empty result set is an error
multipleResultsIsError	Boolean	false	Whether a result set with more than one result is an error
connectionStrategy	One of `ROUND_ROBIN, RANDOM, ACTIVE_PASSIVE`	`ACTIVE_PASSIVE`	If Multiple URLs were provided as the ldapURL this describes how each URL will be processed. ACTIVE_PASSIVE (default value) - Indicates that the first LDAP URL will be used for every request unless it fails and then the next LDAP URL will be used. ROUND_ROBIN - Indicates that for each new connection the next LDAP url in the list (circling back to the start of the list when the end is reached) will be used RANDOM - Indicates that for each new connection a random LDAP url will be selected
searchScope	One of `SUBTREE, ONELEVEL, OBJECT`	`SUBTREE`	The scope of the search. SUBTREE: The entire LDAP directory subtree below the search baseDN will be searched. ONELEVEL: Only the immediate children of LDAP object corresponding to the search baseDN will be searched. OBJECT: Only the LDAP object itself is searched.
derefAliases	One of `NEVER, SEARCHING, FINDING, ALWAYS`	NEVER	How aliases should be dereferenced.
followReferrals	Boolean	false	Whether to follow search referrals and references when they are encountered in search results.
useStartTLS	Boolean	false	Whether to use startTLS when connecting to the LDAP
disableHostnameVerification	Boolean	false	Whether to enforce certificate name checking during TLS, only change if you understand the implications
authCert	File pathname		Path to the file containing the X.509 certificate to provide when connecting to the directory over LDAPS or startTLS
authKey	File pathname		Path to the file containing the private key to provide when connecting to the directory over LDAPS or startTLS
authKeyPassword	String		Password to use for the private key file
The following are rarely used but allow pieces of the connector configuration to be delegated to Spring bean definitions, bypassing the built-in syntax for configuring these features (or in the event that a custom implementation of the relevant interfaces is to be used).
templateEngine	Bean ID		The ID of a Spring bean defining a org.apache.velocity.app.VelocityEngine
searchOperationRef	Bean ID		The ID of a Spring bean defining an org.ldaptive.SearchOperation
connectionFactoryRef	Bean ID		The ID of a Spring bean defining a org.ldaptive.ConnectionFactory
mappingStrategyRef	Bean ID		The ID of a Spring bean defining a MappingStrategy (which converts the result of an LDAP search into a list of IdP Attributes).
executableSearchBuilderRef	Bean ID		The ID of a Spring bean defining an ExecutableSearchBuilder<ExecutableSearchFilter>
validatorRef	Bean ID		Bean ID of a Validator to control what constitutes an initialization failure if failFastInitialize is not sufficient

Name	Cardinality	Description

Name	Cardinality	Description
<FilterTemplate>	0 or 1	The template of the search filter to be sent to the LDAP directory server
<ReturnAttributes>	0 or 1	A list of attributes to be returned from the LDAP directory server; this may help the server respond more quickly
<BinaryAttributes>	0 or 1	A list of attributes whose values contain binary data and must be base64 encoded; format is a space-delimited list of attribute names, which MUST match the directory source exactly (including case and any LDAP options)
<StartTLSTrustCredential>	0 or 1	X.509 trust information to use when connecting to the directory over LDAPS or startTLS, DEPRECATED in favor of the `trustFile` attribute
<StartTLSAuthenticationCredential>	0 or 1	X.509 client authentication information to provide when connecting to the directory over LDAPS or startTLS, DEPRECATED in favor of the `authCert`, `authKey`, and `authKeyPassword` attributes
<ConnectionPool>	0 or 1	Describes how the LDAP connection may be pooled
<SASLConfig>	0 or 1	SASL configuration to provide when binding to the directory.
<Column>	0 or more	Allows for remapping of LDAP Attributes into alternately named IdPAttributes within the resolver
<ResultCache>	0 or 1	The definition of how results should be cached
<ResultCacheBean>	0 or 1	The definition of how results should be cached as an externally defined Cache<String,Map<String,IdPAttribute>>, the Spring bean ID of which is supplied as the content of the element