Integration Details

ThreatQuotient provides the following details for this integration:

Introduction

The ThreatQ Connector for Microsoft Active Directory provides a way for users to import their active directory identities into ThreatQ.

ThreatQ v6 Users – while the connector’s overall operation remains the same, installation and usage commands for ThreatQ v6 users will differ from what is listed in this guide. See the Installing Custom Connectors in ThreatQ v6 and Installing Custom Connectors on Another Instance topics for additional information.

Prerequisites

Review the following requirements before attempting to install the connector.  

Time Zone

You should ensure all ThreatQ devices are set to the correct time, time zone, and date (UTC is recommended), and using a clock source available to all.

To identify which time zone is closest to your present location, use the timedatectl command with the list-timezones command line option.

For example, enter the following command to list all available time zones in Europe:

Enter the following command, as root, to change the time zone to UTC:

Generating a Certificate

If you are using SSL/TLS with your LDAP server (ldaps://), you can enable the use of a certificate by generating one, then entering the full path into the configuration. Use the following command to generate a certificate:

Integration Dependencies

The integration must be installed in a python 3.6 environment.

The following is a list of required dependencies for the integration.  These dependencies are downloaded and installed during the installation process.  If you are an Air Gapped Data Sync (AGDS) user, or run an instance that cannot connect to network services outside of your infrastructure, you will need to download and install these dependencies separately as the integration will not be able to download them during the install process.

Items listed in bold are pinned to a specific version.  In these cases, you should download the version specified to ensure proper function of the integration.

Installation

The following provides you with steps on installing a Python 3 Virtual Environment and installing the connector.

Creating a Python 3.6 Virtual Environment  

Run the following commands to create the virtual environment:

Proceed to Installing the Connector.

Installing the Connector

Upgrading Users - Review the Change Log for updates to configuration parameters before updating.  If there are changes to the configuration file (new/removed parameters), you must first delete the previous version's configuration file before proceeding with the install steps listed below.  Failure to delete the previous configuration file will result in the connector failing.

1. Navigate to the ThreatQ Marketplace and download the .whl file for the integration.
2. Activate the virtual environment if you haven't already:
   source /opt/tqvenv/<environment_name>/bin/activate
3. Transfer the whl file to the /tmp directory on your ThreatQ instance.  
4. Install the connector on your ThreatQ instance:
   pip install /tmp/tq_conn_active_directory-<version>-py3-none-any.whl 

   A driver called tq-conn-tq_conn_active_directory will be installed.   After installing, a script stub will appear in /opt/tqvenv/<environment_name>/bin/tq-conn-tq_conn_active_directory .

5. Once the application has been installed, a directory structure must be created for all configuration, logs and files, using the mkdir -p command. Use the commands below to create the required directories:
   mkdir -p /etc/tq_labs/
   mkdir -p /var/log/tq_labs/
6. Perform an initial run using the following command:
   /opt/tqvenv/<environment_name>/bin/tq-conn-active-directory -ll /var/log/tq_labs/ -c /etc/tq_labs/ -v3
7. Enter the following parameters when prompted:

   Parameter	Description
   ThreatQ Host	This is the host of the ThreatQ instance, either the IP Address or Hostname as resolvable by ThreatQ.
   ThreatQ Client ID	This is the OAuth id that can be found at Settings Gear → User Management → API details within the user’s details.
   ThreatQ Username	This is the Email Address of the user in the ThreatQ System for integrations.
   ThreatQ Password	The password for the above ThreatQ account.

   Example Output

   /opt/tqvenv/<environment_name>/bin/tq-conn-active-directory -ll /var/log/tq_labs/ -c /etc/tq_labs/ -v3
   ThreatQ Host: <ThreatQ Host IP or Hostname> 
   ThreatQ Client ID: <ClientID> 
   ThreatQ Username: <EMAIL ADDRESS> 
   ThreatQ Password: <PASSWORD> 
   Connector configured. Set information in UI

You will still need to configure and then enable the connector.

Configuration

ThreatQuotient does not issue API keys for third-party vendors. Contact the specific vendor to obtain API keys and other integration-related credentials.

To configure the integration:

1. Navigate to your integrations management page in ThreatQ.
2. Select the Labs option from the Category dropdown (optional).
3. Click on the integration entry to open its details page.
4. Enter the following parameters under the Configuration tab:

   Parameter	Description
   Active Directory Server	The address to your LDAP server. ldap:// or ldaps:// must be included.
   Active Directory Domain	The domain used by your LDAP server
   Certificate Path	The path to your certificate associated with your LDAP server. See the Generating a Certificate section for more details. This path must be accessible by the connector. This path is the full path to the .pem file.   Leaving this blank will result in not using a certificate.
   Use TLS	Enable/disable TLS for your connection.
   Active Directory Username	The username to use to authenticate with your LDAP server.
   Active Directory Password	The password used to authenticate with your LDAP server.
   Common Names	A list of common names to pull users from. The connector pulls all subtrees of a common name, configure accordingly.  This list must be in level order (top-most to bottom-most)
   Organizational Units	A list of organizational units to pull users from. The connector pulls all subtrees of a OU, configure accordingly. This list must be in level order (top-most to bottom-most)
   Active Directory Version	Set your version of Active Directory. The default setting is v3.
   Import Emails and Usernames as Indicators	Configure where email addresses and username are imported as indicators into ThreatQ. Emails and usernames are added as attributes to identify objects by default.  Selecting Yes will result in emails and usernames being imported as related indicators.
   Additional Identity Information	Enter any additional identity information to import in this field. By default, basic identity information such as username, name, manager, position, company, office location, etc. is included.

5. Review any additional settings, make any changes if needed, and click on Save.
6. Click on the toggle switch, located above the Additional Information section, to enable it.

Usage

Use the following command to execute the driver:

Command Line Arguments

This connector supports the following custom command line arguments:

CRON

Automatic CRON configuration has been removed from this script. To run this script on a recurring basis, use CRON or some other jobs scheduler. The argument in the CRON script must specify the config and log locations.

Add an entry to your Linux crontab to execute the connector at a recurring interval. Depending on how quickly you need updates, this can be run multiple times a day (no more than once an hour) or a few times a week.

In the example below, the command will execute the connector every two hours.

1. Log into your ThreatQ host via a CLI terminal session.
2. Enter the following command:
   crontab -e

   This will enable the editing of the crontab, using vi. Depending on how often you wish the cronjob to run, you will need to adjust the time to suit the environment.

3. Enter the commands below:

   Every 2 Hours Example

   0 */2 * * * /opt/tqvenv/<environment_name>/bin/tq_conn_active_directory -c /etc/tq_labs/ -ll /var/log/tq_labs/ -v3  
4. Save and exit CRON.

Change Log

• Version 1.1.1
  • Added pagination to API requests. 
• Version 1.1.0
  • Added Python 3 support.
• Version 1.0.0
  • Initial Release