By default CloverDX Server allows only its own internal mechanism for authentication. To enable authentication with LDAP, set the configuration property security.authentication.allowed_domains properly. The value of the property is a list of user domains that are used for authentication, e.g.: security.authentication.allowed_domains = clover,LDAP

When set as in the example above, users from both domain may login. (clover is an identifier of CloverDX internal authentication and may be changed by the security.default_domain property, but only for white-labeling purposes.) It's recommended to allow both mechanisms together, until the LDAP is properly configured. So the admin user can still login to web GUI although the LDAP connection isn't properly configured.

You can use Setup to configure LDAP authentication. See LDAP in Chapter 13, Setup.

# Implementation of context factory.
security.ldap.ctx_factory=com.sun.jndi.ldap.LdapCtxFactory
# URL of LDAP server.
security.ldap.url=ldap://hostname:port
# User DN pattern that will be used to create LDAP user DN from login name.
security.ldap.user_dn_pattern=uid=$${username},dc=company,dc=com

Depending on the LDAP server configuration, the property security.ldap.user_dn_pattern can be pattern for user's actual distinguished name in the LDAP directory, or just the login name - in such a case just set the property to $${username}.

In order to be able to synchronize the Clover groups with those defined in LDAP directory, the security.ldap.user_dn_pattern has to be left unspecified. There are additional properties required so that the server is able to search the LDAP directory.

# User DN of a user that has sufficient privileges to search LDAP for users and groups.
security.ldap.userDN=cn=Manager,dc=company,dc=com
# The password for user mentioned above.
security.ldap.password=

There are optional settings affecting how the LDAP directory is searched.

# Timeout for queries searching the directory.
security.ldap.timeout=5000
# Maximal number of records that the query can return.
security.ldap.records_limit=2000
# How LDAP referrals are processed, possible values are: 'follow', 'ignore' and 'throw'.
# The default depends on the context provider.
security.ldap.referral=

Specified values work for this specific LDAP tree:

Following properties are necessary for lookup for the LDAP user by his username. (step [4] in the login process above)

# Base specifies the node of LDAP tree where the search starts.
security.ldap.user_search.base=dc=company,dc=eu
# Filter expression for searching the user by his username.
# Note, that this search query must return just one record.
# Placeholder ${username} will be replaced by username specified by the logging user.
security.ldap.user_search.filter=(uid=$${username})
# Scope specifies type of search in "base". There are three possible values: SUBTREE | ONELEVEL | OBJECT
# http://download.oracle.com/javase/8/docs/api/javax/naming/directory/SearchControls.html
security.ldap.user_search.scope=SUBTREE

Following properties are names of attributes from the search defined above. They are used for getting basic info about the LDAP user in case the user record has to be created/updated by CloverDX security module: (step [6] in the login process above)

security.ldap.user_search.attribute.firstname=fn
security.ldap.user_search.attribute.lastname=sn
security.ldap.user_search.attribute.email=mail
# This property is related to the following step "searching for groups".
# Groups may be obtained from specified user's attribute, or found by filter (see next paragraph).
# Leave this property empty if the user doesn't have such attribute.
security.ldap.user_search.attribute.groups=memberOf

In the following step, CloverDX tries to find groups which the user is assigned to. (step [4] in the login process above). There are two ways how to get list of groups which the user is assigned to. The user-groups relation is specified on the "user" side. The user record has some attribute with list of groups. It's "memberOf" attribute usually. Or the relation is specified on the "group" side. The group record has an attribute with list of assigned users. It's "member" attribute usually.

In case the relation is specified on users side, please specify the property:

security.ldap.user_search.attribute.groups=memberOf

Leave it empty otherwise.

In case the relation is specified on the groups side, set properties for searching:

security.ldap.groups_search.base=dc=company,dc=com
# Placeholder ${userDN} will be replaced by user DN found by the search above.
# If the filter is empty, searching will be skipped.
security.ldap.groups_search.filter=(&(objectClass=groupOfNames)(member=$${userDN}))
security.ldap.groups_search.scope=SUBTREE

Otherwise, please leave property security.ldap.groups_search.filter empty, so the search will be skipped.

Clover user record will be assigned to the clover groups according to the LDAP groups found by the search (or the attribute). (Groups synchronization is performed during each login)

# Value of the following attribute will be used for lookup for the CloverDX group by its code.
# So the user will be assigned to the CloverDX group with the same "code".
security.ldap.groups_search.attribute.group_code=cn

CloverDX Server uses User Principal Name (UPN) username@domainname for user authentication with Active Directory.

So if the domain name is the same for all CloverDX Server users, you can set security.ldap.user_dn_pattern to contain the name of the domain and then log in just using the user name, e.g. john.doe:

security.ldap.user_dn_pattern=$${username}@mydomain

If you need to use multiple domain names, use security.ldap.user_dn_pattern=$${username} instead and then enter the full UPN as the User name on the login page, e.g. john.doe@mydomain.