An authentication policy for users whose credentials are managed
by a remote LDAP directory service.
Authentication attempts will be redirected to the remote LDAP
directory service based on a combination of the criteria specified in this
policy and the content of the user's entry in this directory server.
One or more mapped attributes must be specified when using the
"mapped-bind" or "mapped-search" mapping policies.
One or more search base DNs must be specified when using the
"mapped-search" mapping policy.
The mapped search bind password must be specified when using the
"mapped-search" mapping policy and a mapped-search-bind-dn is defined.
The cached password storage scheme must be specified when password
caching is enabled.
ds-cfg-ldap-pass-through-authentication-policy
ds-cfg-authentication-policy
org.opends.server.extensions.LDAPPassThroughAuthenticationPolicyFactory
Specifies the primary list of remote LDAP servers which should
be used for pass through authentication.
If more than one LDAP server is specified then operations
may be distributed across them. If all of the primary LDAP servers are
unavailable then operations will fail-over to the set of secondary LDAP
servers, if defined.
^.+:[0-9]+$
HOST:PORT
A host name followed by a ":" and a port number.
ds-cfg-primary-remote-ldap-server
Specifies the secondary list of remote LDAP servers which
should be used for pass through authentication in the event that the
primary LDAP servers are unavailable.
If more than one LDAP server is specified then operations
may be distributed across them. Operations will be rerouted to the primary
LDAP servers as soon as they are determined to be available.
No secondary LDAP servers.
^.+:[0-9]+$
HOST:PORT
A host name followed by a ":" and a port number.
ds-cfg-secondary-remote-ldap-server
If specified, the server will bind to the address before connecting to the
remote server.
The address must be one assigned to an existing network interface.
Let the server decide.
ds-cfg-source-address
Specifies the timeout used when connecting to remote LDAP
directory servers, performing SSL negotiation, and for individual search
and bind requests.
If the timeout expires then the current operation will be
aborted and retried against another LDAP server if one is available.
3 seconds
ds-cfg-connection-timeout
Specifies the name of the trust manager that should be used
when negotiating SSL connections with remote LDAP directory servers.
Changes to this property take effect immediately, but only
impact subsequent SSL connection negotiations.
By default, no trust manager is specified indicating that only
certificates signed by the authorities associated with this JVM will
be accepted.
The referenced trust manager provider must be enabled
when SSL is enabled.
ds-cfg-trust-manager-provider
Specifies the mapping algorithm for obtaining the bind DN from
the user's entry.
unmapped
Bind to the remote LDAP directory service using the DN
of the user's entry in this directory server.
Bind to the remote LDAP directory service using a DN
obtained from an attribute in the user's entry. This policy will
check each attribute named in the "mapped-attribute" property. If
more than one attribute or value is present then the first one will
be used.
Bind to the remote LDAP directory service using the DN
of an entry obtained using a search against the remote LDAP
directory service. The search filter will comprise of an equality
matching filter whose attribute type is the "mapped-attribute"
property, and whose assertion value is the attribute value obtained
from the user's entry. If more than one attribute or value is
present then the filter will be composed of multiple equality
filters combined using a logical OR (union).
ds-cfg-mapping-policy
Specifies one or more attributes in the user's entry whose
value(s) will determine the bind DN used when authenticating to the remote
LDAP directory service. This property is mandatory when using the
"mapped-bind" or "mapped-search" mapping policies.
At least one value must be provided. All values must refer
to the name or OID of an attribute type defined in the directory server
schema. At least one of the named attributes must exist in a user's
local entry in order for authentication to proceed. When multiple
attributes or values are found in the user's entry then the behavior is
determined by the mapping policy.
ds-cfg-mapped-attribute
Specifies the bind DN which should be used to perform user
searches in the remote LDAP directory service.
Searches will be performed anonymously.
ds-cfg-mapped-search-bind-dn
If defined, overrides the filter used when searching for the user, substituting
%s with the value of the local entry's "mapped-attribute".
The filter-template may include ZERO or ONE %s substitutions.
If multiple mapped-attributes are configured, multiple renditions of this template
will be aggregated into one larger filter using an OR (|) operator.
An example use-case for this property would be to use a different attribute type
on the mapped search. For example, mapped-attribute could be set to "uid" and
filter-template to "(samAccountName=%s)".
ds-cfg-mapped-search-filter-template
Specifies the bind password which should be used to perform
user searches in the remote LDAP directory service.
ds-cfg-mapped-search-bind-password
Specifies the name of a Java property containing the bind password which
should be used to perform user searches in the remote LDAP directory
service.
ds-cfg-mapped-search-bind-password-property
Specifies the name of an environment variable containing the bind
password which should be used to perform user searches in the remote LDAP
directory service.
ds-cfg-mapped-search-bind-password-environment-variable
Specifies the name of a file containing the bind
password which should be used to perform user searches in the remote LDAP
directory service.
ds-cfg-mapped-search-bind-password-file
Specifies the set of base DNs below which to search for users
in the remote LDAP directory service. This property is mandatory when
using the "mapped-search" mapping policy.
If multiple values are given, searches are performed below
all specified base DNs.
ds-cfg-mapped-search-base-dn
Indicates whether LDAP connections should use TCP keep-alive.
If enabled, the SO_KEEPALIVE socket option is used to
indicate that TCP keepalive messages should periodically be sent to the
client to verify that the associated connection is still valid. This may
also help prevent cases in which intermediate network hardware
could silently drop an otherwise idle client connection, provided
that the keepalive interval configured in the underlying operating
system is smaller than the timeout enforced by the network hardware.
true
ds-cfg-use-tcp-keep-alive
Indicates whether LDAP connections should use TCP no-delay.
If enabled, the TCP_NODELAY socket option is used to ensure
that response messages to the client are sent immediately rather
than potentially waiting to determine whether additional response
messages can be sent in the same packet. In most cases, using the
TCP_NODELAY socket option provides better performance and
lower response times, but disabling it may help for some cases in
which the server sends a large number of entries to a client
in response to a search request.
true
ds-cfg-use-tcp-no-delay
Specifies the names of the SSL protocols which are allowed for
use in SSL based LDAP connections.
Changes to this property take effect immediately but will
only impact new SSL LDAP connections created after the
change.
Uses the default set of SSL protocols provided by the
server's JVM.
ds-cfg-ssl-protocol
Specifies the names of the SSL cipher suites that are allowed
for use in SSL based LDAP connections.
Changes to this property take effect immediately but will
only impact new SSL LDAP connections created after the
change.
Uses the default set of SSL cipher suites provided by the
server's JVM.
ds-cfg-ssl-cipher-suite
Indicates whether passwords should be cached locally within the user's
entry.
false
ds-cfg-use-password-caching
Specifies the name of a password storage scheme which should be used
for encoding cached passwords.
Changing the password storage scheme will cause all existing cached
passwords to be discarded.
The referenced password storage schemes must be enabled.
ds-cfg-cached-password-storage-scheme
Specifies the maximum length of time that a locally cached password may
be used for authentication before it is refreshed from the remote LDAP
service.
This property represents a cache timeout. Increasing the timeout period
decreases the frequency that bind operations are delegated to the
remote LDAP service, but increases the risk of users authenticating
using stale passwords.
Note that authentication attempts which fail because the provided password
does not match the locally cached password will always be retried against
the remote LDAP service.
8 hours
ds-cfg-cached-password-ttl