How to Configure an LDAP Authentication Provider#
This topic provides step-by-step instructions for configuring an Lightweight Directory Access Protocol (LDAP) authentication provider in TheHive.
Required permissions
Only users with an admin-type profile that has the managePlatform
permission can configure authentication in TheHive.
Procedure
Local account
Users must have an existing account in TheHive's local database to authenticate successfully. Configure the LDAP servers in TheHive to automate account creation.
User data is synchronized periodically:
- New LDAP users are automatically created in TheHive.
- Removed users become inactive.
- Organization membership and user profiles are assigned based on LDAP group membership.
The configuration must include a mapping of LDAP groups to corresponding organizations and profiles.
Prerequisites
- Users must have an existing account in TheHive's local database to authenticate successfully.
- These steps assume that you have already followed the instructions to configure the authentication settings.
-
Go to the Platform management view from the sidebar menu.
-
Select the Authentication tab.
-
Select Directories authentication in the Authentication providers section.
-
In the Directories authentication drawer, turn on the Enable directory toggle.
-
Select ldap from the dropdown list.
-
Enter the servers host name or IP address.
Example: ldap.company.com
-
Turn on the Auth-use SSL toggle to encrypt communication between TheHive and the authentication provider.
For more information about configuring SSL, refer to the Configure SSL topic.
-
Enter the following information:
- DN of the service account
The Distinguished Name (DN) of the service account used for authentication. This account is responsible for binding to the LDAP directory and performing search operations.
Example: cn=thehive,ou=users,dc=company,dc=com
- Bind password
The password associated with the service account. This password authenticates the service account to allow LDAP queries.
- Users base DN
The base DN from which the search for user accounts will begin. This limits the search scope to a specific branch of the directory.
Example: ou=users,dc=company,dc=com
- Filter used to search users
The LDAP filter to locate user accounts. This filter helps narrow down search results to relevant users.
Example: (&(uid={0})(objectClass=inetOrgPerson))
-
Select Confirm.