Use Lightweight Directory Access Protocol (LDAP) With Symphony

This applies to: Visual Data Discovery

Lightweight Directory Access Protocol (LDAP) is an application protocol used over an IP network to manage and access directory information contained in an organization’s secured network. Symphony has been tested and can be used with Active Directory and OpenLDAP directory services. The Symphony server can be configured to use one of these LDAP services to authenticate users. When LDAP is enabled, users can log into Symphony using their familiar LDAP identity and credentials.

Only supervisors can manage Symphony LDAP configurations.

The default supervisor user is no longer installed; add users to the Supervisors group instead.

User attributes set in regular Symphony user definitions via the UI or in LDAP user definitions are encrypted when stored in metadata. To specify the encryption mode, see Change the Encryption Mode.

Connecting Symphony to an LDAP directory requires coordination between the authorized LDAP administrator and the Symphony administrator. After enabling LDAP authentication in Symphony, you can import users in the LDAP directory of your organization. All user information will be maintained in LDAP, not in your Symphony user accounts.

The following LDAP configuration information is needed to configure LDAP in Symphony:

Screen Box	Description
URL	The LDAP connection string for connecting to the LDAP repository. Connection string is of the following format: ldap://<ldap-server>:<ldap-port> Replace `<ldap-server>` with the DNS name or IP address of the LDAP repository server Replace `<ldap-port>` with the port number where the LDAP service is listening on `<ldap-server>` (typically port 389)
Bind user	User name credential of the service account that (at minimum) has read access to the LDAP repository.
Bind password	Password credential for the Bind user (LDAP service account).
Search base	Identifies the Distinguished Name (DN) - the location in the LDAP directory tree where to begin queries for registered users in the LDAP directory.
Query	LDAP query that will resolve a specific set of users group found in the search base to be imported into Symphony.
User ID attribute	Identifier attribute for users in LDAP implementation of your organization. The following user ID attributes are supported: UID, CN, sAMAccountname, and userPrincipalName. This attribute will determine how user names will be represented in Symphony.

Configure LDAP

To configure LDAP:

Log into the Symphony server as the supervisor user. The Manage Users work area appears, listing all the users in the Symphony instance.
Select Tools > Security from the main menu. The security tabs display.
On the Security Services tab, make sure that the LDAP security service is on. If it is not running, turn it on.
Select the LDAP Settings tab. The LDAP Settings tab has five sections: General Settings, LDAP Server, User Provisioning, Mappings, and Mappings to Custom User Attributes.
In the General Settings section, switch the Enable LDAP option on (slide it to the right).
Enter the LDAP connection URL (DNS or IP address) where the LDAP directory resides.
Enter the Bind User and Bind Password credentials. The authorized LDAP administrator needs to provide these credentials.
Specify the Search Base which is the DN or location in the LDAP directory tree where a search for registered users can begin. An example entry is provided in the text field: OU=people,DC=zoomdata,DC=local, where:
- OU means organizational unit
- DC means domain controller
Provide a query string that can run to identify user nodes under the Search Base. An example is provided in the text field: (objectclass=person). Keep in mind that you can only import individual users into Symphony. As a result, your query should be limited to objects that are designated as a “person” or “user.” Use a search engine to look up 'common LDAP query strings'.
Optionally enable user provisioning, configure mappings and mappings to custom user attributes.
Manually import users from the LDAP directory. See Manually Importing Users from the LDAP Directory.
To use the secure LDAP connection, import the certificate to your local jre key store. See Using the Secure LDAP Connection.

Enable User Provisioning

Use the User Provisioning section to enable user provisioning. User provisioning allows you to verify the identity of users that log into Symphony against the LDAP directory and automatically create new users in Symphony if the user's credentials have been validated against the LDAP directory.

If disabled, you must manually import the users in order to allow them to log into Symphony. See Manually Importing Users from the LDAP Directory.

When you have enabled the auto provisioning feature, you can select the default account for the provisioned users to be added.

The Default Account list contains all the account names, that are available within your Symphony instance. If you want the users to be added to one of them, select the corresponding account. Otherwise, select the User Account Mapping option to configure the mappings with LDAP attributes for your users.

Configure Mappings

Use the Mappings subtab to define mappings that bind the user attributes from LDAP and Symphony.

Select Login Name Mapping attribute from the list that will be used as a user login. There are four User ID Attributes supported: UID, CN, sAMAccountname, and userPrincipalName.
Account Mapping - select the account to which the user should be added. Account names are case-sensitive.
Active Account Mapping - select the account to which the user will log in for the first time
Full Name Mapping
Email mapping
If you want to import users and the groups which they are assigned to, in the Group mapping attribute box, type the name of the corresponding column in LDAP.
If you want Symphony to automatically create groups for users if they don't exist in your environment yet, turn on Auto Create Groups (slide the switch to the right).

After the credentials are verified, the user groups will be created in Symphony and each user will be assigned to the corresponding group.

Manage Mappings to Custom User Attributes

You can associate custom user attributes with a Symphony user on the Mappings to Custom User Attributes subtab. Custom user attributes can to store values used for credential pass through. This means that if users have access to a particular data source that has been connected to Symphony, their credentials can be saved on this page so that their access privileges are maintained for that source within Symphony.

Manually Import Users from the LDAP Directory

To manually import users from the LDAP directory to Symphony:

The default supervisor user is no longer installed; add users to the Supervisors group instead.

Log in as the supervisor user. The Manage Users work area appears, listing all the users in the Symphony instance. If you navigate away from this work area, you can always access it by selecting Tools > Users from the main menu.
On the Users page, select Import Users. A list of users in the LDAP directory is displayed.
To import specific users, select them from the list. To import all users, select Select All.
Select Import.

If needed, you can delete imported users using the Users list in the left pane.

After users have been imported into Symphony, they can be assigned groups and permissions. For an overview of how Symphony manages users and groups and how to assign groups and permissions, see Authorize Symphony Access.

When a user is imported from Active Directory or if user provisioning is enabled and a new Active Directory user is added, the corresponding Symphony user definition is automatically added. However, when a user is removed from Active Directory, the corresponding Symphony user definition is not automatically removed. Symphony authentication does not occur for the removed user, but you will need to manually remove the Symphony user definition.

Use the Secure LDAP Connection

To use the secure LDAP connection, you need to import the certificate to your local jre key store.

Run the following command:

sudo keytool -import -file <ca_file_name>.pem -keystore /opt/zoomdata/jre/lib/security/cacerts

Restart Symphony after importing the certificate:
```
sudo service zoomdata restart
```

Now when using a secure connection to LDAP, the URL must be as follows:

ldaps://<ldap_server>:636