Configure remote authentication through LDAP

The ExtraHop system supports the Lightweight Directory Access Protocol (LDAP) for authentication and authorization. Instead of storing user credentials locally, you can configure your ExtraHop system to authenticate users remotely with an existing LDAP server. Note that ExtraHop LDAP authentication only queries for user accounts; it does not query for any other entities that might be in the LDAP directory.

1. Log in to the Administration settings on the ExtraHop system through https://<extrahop-hostname-or-IP-address>/admin.
2. In the Access Settings section, click Remote Authentication.
3. From the Remote authentication method drop-down list, select LDAP and then click Continue.
4. On the LDAP Settings page, complete the following server information fields:
   1. In the Hostname field, type the hostname or IP address of the LDAP server. If you are configuring a hostname, make sure that the DNS entry of the ExtraHop system is properly configured.
   2. In the Port field, type the port number on which the LDAP server is listening.
   3. From the Server Type drop-down list, select Posix or Active Directory.
   4. (Optional): In the Bind DN field, type the bind DN. The bind DN is the user credentials that allow you to authenticate with the LDAP server to perform the user search. The bind DN must have list access to the base DN and any OU, groups, or user account required for LDAP authentication. If this value is not set, then an anonymous bind is performed. Note that anonymous binds are not enabled on all LDAP servers.
   5. (Optional): In the Bind Password field, type the bind password. The bind password is the password required when authenticating with the LDAP server as the bind DN specified above. If you are configuring an anonymous bind, leave this field blank. In some cases, an unauthenticated bind is possible, where you supply a Bind DN value but no bind password. Consult your LDAP administrator for the proper settings.
   6. From the Encryption drop-down list, select one of the following encryption options.

      None: This options specifies cleartext TCP sockets. All passwords are sent across the network in cleartext in this mode.

      LDAPS: This option specifies LDAP wrapped inside SSL.

      StartTLS: This option specifies TLS LDAP. (SSL is negotiated before any passwords are sent.)

   7. Select Validate SSL Certificates to enable certificate validation. If you select this option, the certificate on the remote endpoint is validated against the root certificates as specified by the trusted certificates manager. You must configure which certificates you want to trust on the Trusted Certificates page. For more information, see Add a trusted certificate to your ExtraHop system.
   8. In the Refresh Interval field, type a time value or leave the default setting of 1 hour.
      The refresh interval ensures that any changes made to user or group access on the LDAP server are updated on the ExtraHop system.
5. Configure the following user settings:
   1. In the Base DN field, type the base distinguished name (DN).
      The Base DN is the point from where a server will search for users. The base DN must contain all user accounts that will have access to the ExtraHop system. The users can be direct members of the base DN or nested within an OU within the base DN if the Whole Subtree option is selected for the Search Scope specified below.
   2. In the Search Filter field, type a search filter.
      Search filters enable you to define search criteria when searching the LDAP directory for user accounts.

      Important:

      The ExtraHop system automatically adds parentheses to wrap the filter and will not parse this parameter correctly if you add parentheses manually. Add your search filters in this step and in step 5b, similar to the following example: cn=atlas* |(cn=EH-*)(cn=IT-*) In addition, if your group names include the asterisk (*) character, the asterisk must be escaped as Copy \2a. For example, if your group has a CN called test*group, type cn=test\2agroup in the Search Filter field.

   3. From the Search Scope drop-down list, select one of the following options.
      Search scope specifies the scope of the directory search when looking for user entities.

      Whole subtree: This option looks recursively under the group DN for matching users.

      Single level: This option looks for users that exist in the base DN only; not any subtrees.

6. (Optional): To import user groups, select the Import user groups from LDAP server checkbox and configure the following settings.

   Note:

   Importing LDAP user groups enables you to share dashboards with those groups. The imported groups appear on the User Group page in the Administration settings.

   1. In the Base DN field, type the base DN.
      The Base DN is the point from where a server will search for user groups. The base DN must contain all user groups that will have access to the ExtraHop system. The user groups can be direct members of the base DN or nested within an OU within the base DN if the Whole Subtree option is selected for the Search Scope specified below.
   2. In the Search Filter field type a search filter.
      Search filters enable you to define search criteria when searching the LDAP directory for user groups.

      Important:

      For group search filters, the ExtraHop system implicitly filters on the objectclass=group, and so objectclass=group should not be added to this filter.

   3. From the Search Scope drop-down list, select one of the following options.
      Search scope specifies the scope of the directory search when looking for user group entities.

      Whole subtree: This option looks recursively under the base DN for matching user groups.

      Single level: This option looks for user groups that exist in the base DN; not any subtrees.

7. Click Test Settings.
   If the test succeeds, a status message appears near the bottom of the page. If the test fails, click Show details to see a list of errors. You must resolve any errors before you continue.
8. Click Save and Continue.