LDAP Servers

If your organization uses LDAP authentication, you can set the parameters for AlarmPoint’s communications with your LDAP servers in the web user interface. Before configuring the LDAP options in AlarmPoint, it is recommended that you discuss requirements with your LDAP administrator.

In a multiple-Company deployment, LDAP servers and domains are Company-specific, and Company Administrators must specify their LDAP settings separately for each Company in AlarmPoint.

To manage LDAP server settings:
  1. On the LDAP Servers page, specify the following information:

Detail

Description

Primary Host

IP address of the primary LDAP Server for AlarmPoint.

Primary Port

Port number AlarmPoint should use to communicate with the primary LDAP Server.

Use SSL

When selected, uses the Secure Sockets Layer protocol when communicating with the primary LDAP server.

Secondary Host

IP address of the secondary (failover) LDAP Server for AlarmPoint. For more information about the secondary LDAP server settings, see "Secondary LDAP Servers", below.

Secondary Port

Port number AlarmPoint should use to communicate with the secondary LDAP Server

Use SSL

When selected, uses the Secure Sockets Layer protocol when communicating with the secondary LDAP server.

LDAP Domains

Network domains Users can log into through the LDAP Servers. The domains listed here determine the choices available to Users in the LDAP Domain list on the Change Web Login page.

  1. To add a new LDAP Domain, click Add New Domain, and then specify the details for the domain:
    1. Name: identifies the LDAP domain for Users.
    2. Template: the string submitted for authentication to the LDAP server. Each template must contain the token %UID%, which will be replaced by the Web Login ID from each User’s profile details; see Creating LDAP Templates below.
  2. To remove an LDAP domain, select the check box next to the domain you want to delete, and then click Remove Domain.
  3. Click Save to apply your settings.

If you have any difficulties configuring your LDAP details, you can view the <AlarmPoint>/webserver/webapps/cocoon/WEB-INF/logs/AlarmPoint_WebApp.log file for information about the log in attempts.

Secondary LDAP Servers

In AlarmPoint, the secondary LDAP server settings provide redundancy for failover situations. The secondary server is contacted only if there is a connection failure with the primary server; otherwise, responses from the primary server are considered authoritative.

The following use cases provide examples of how and when AlarmPoint contacts the secondary server.

Login Use Case One

  1. The connection to the primary server succeeds.
  2. An LDAP bind operation is requested for authentication based on the supplied user credentials.
  3. A failed response is returned.
  4. An error message is displayed, indicated that the user credentials are not valid.

Note that AlarmPoint does not attempt to contact the secondary LDAP server based on invalid user credentials.

Login Use Case Two

  1. The connection to the primary server fails.
  2. The connection to the secondary server succeeds.
  3. An LDAP bind operation is requested for authentication based on the supplied user credentials.
  4. A failed response is returned.
  5. An error message is displayed, indicated that the user credentials are not valid.

Login Use Case Three

  1. The connection to the primary server fails
  2. The connection to the secondary server fails.
  3. An error message is displayed, indicating that the server cannot be contacted.

Creating LDAP Templates

AlarmPoint uses the LDAP template with the login name and password to validate against the LDAP Server. Unlike many applications with LDAP integration, AlarmPoint attempts to log in the user.

AlarmPoint substitutes the login name supplied by the User for the %UID% in the template configured on the LDAP Servers page, and sends this and the password making the login request to the LDAP directory. AlarmPoint then examines the result to determine whether the user has valid credentials.

There are three standard formats for these templates:

Note: If the AlarmPoint Login ID is not part of the Distinguished Name, you must configure the ldap.properties file to query the LDAP Directory and bind the DN to the User, as explained in the following section.

Querying a Distinguished Name

If you do not know the format of the DN, or if the AlarmPoint Login ID is not part of the DN, you can configure the ldap.properties file (supported after applying AlarmPoint 4.0.0 patch 002 or higher) to query the LDAP Directory and bind the correct DN to the User. Note that to use this feature, the LDAP server must support anonymous access for querying the DN; searching with bindID and password is not supported.

Note: Bind query search is available on AlarmPoint 3.2.1 patch 11 and higher, and AlarmPoint 4.0 patch 5 and higher; otherwise, the LDAP server must support anonymous access for querying the DN. Searching with bindID and password is not supported.

Create the LDAP configuration file in the following directory:

<AlarmPoint>/common/
 

This file includes the following settings:

Distinguished Name Query File Settings

Setting

Description

queryDN

This parameter must be set to true (i.e., queryDN=true) for AlarmPoint to query for the DN before authentication.

base

This parameter specifies the DN of the LDAP directory branch from which all searches should begin. At a minimum, this value should be set to the top of your LDAP directory tree.

filterPrefix

This parameter specifies the filter prefix used for searching; it must specify a valid LDAP search filter.

Note that the login name is inserted into the template specified in the web user interface, and then appended to the prefix to form the DN query.

bindDN

Optional DN used in conjunction with the password value to bind to the server when searching for entries (if not provided, an anonymous bind is used).

password

Bind password used in conjunction with bindDN. Since the bind password is probably sensitive data, it should be properly protected using APSecure.

Example One

For this example, assume that you do not know the format of the DN for each User, but you know that the User's Login ID is part of the DN, and is identified within the LDAP directory as "uid". You also know that all AlarmPoint Users are part of a specific LDAP branch. You could set the template on the LDAP Servers page to pass in only the User's Login Name: %UID%

The ldap.properties file would resemble the following:

queryDN=true
base=ou=directory,dc=company,dc=com,o=users,ou=alarmpoint
filterPrefix=uid=

Example Two

For this example, assume that you do not know the format of the DN for each User, nor whether the User's Login ID is part of the DN. You do know that the Login ID is part of the User's email address, which is an attribute you can use to search the LDAP directory. The template on the LDAP Servers page would then resemble the Internet format: %UID%@company.com

You could then configure the ldap.properties file to query for the DN based on the email address:

queryDN=true
base=ou=directory,dc=company,dc=com
filterPrefix=email=
Note: After modifying the ldap.properties file, restart the AlarmPoint Webserver.

Example Three

In this example, the LDAP server does not allow anonymous searching. As a result, you must provide a bind DN and password.

You would then configure the ldap.properties file to query for the DN based on the email address:

queryDN=true
base=ou=directory,dc=company,dc=com
filterPrefix=email=
bindDN=cn=bsmith,dc=company,dc=com
password=<password>