Configuring Huntress Connectors

This connector allows Stellar Cyber to ingest logs from Huntress and add the records to the data lake. This connector integrates with the Huntress API to query for agents and incident reports.

Stellar Cyber connectors with the Collect function (collectors) may skip collecting some data when the ingestion volume is large, which potentially can lead to data loss. This can happen when the processing capacity of the collector is exceeded.

Connector Overview: Huntress

               Let us know if you find the above overview useful.

Adding a Huntress Connector

To add a Huntress connector:

1. Obtain credentials
2. Add the connector in Stellar Cyber
3. Test the connector
4. Verify ingestion

Obtaining Huntress Credentials

Before you configure the connector in Stellar Cyber, you must obtain the following Huntress credentials:

• Host URL—hostname of the Huntress server. The default is: https://api.huntress.io/v1.

• API Key—API key associated with a user account, generated from Huntress, and used to authenticate with Huntress

• API Secret Key—API secret key associated with a user account, displayed when the API key is created, and used to authenticate with Huntress

• Organization ID—identifier of the organization

To generate an API key, refer to the Huntress documentation:

1. Log in as an administrative user to <your_account_subdomain>.huntress.io>.

2. Navigate to API Credentials.

   

3. Click the green Generate button.

4. Click Confirm, which generates a public and private key pair. This is your API key and API secret key.

   Store the API key and API secret key in a safe location. It cannot be retrieved later although it can be regenerated.

Locating the Organization ID

To locate the organization ID:

1. Navigate to Organizations.

   

2. Select the organization's name. The organization ID is located in the URL.

   

Adding the Connector in Stellar Cyber

To add a Huntress connector in Stellar Cyber:

1. Log in to Stellar Cyber.

2. Click System | Integration | Connectors. The Connector Overview appears.

   

3. Click Create. The General tab of the Add Connector screen appears. The information on this tab cannot be changed after you add the connector.

   

   The asterisk (*) indicates a required field.

4. Choose Endpoint Security from the Category drop-down.

5. Choose Huntress from the Type drop-down.

6. For this connector, the supported Function is Collect, which is enabled already.

7. Enter a Name.

   This field does not accept multibyte characters.

8. Choose a Tenant Name. The Interflow records created by this connector include this tenant name.

9. Choose the device on which to run the connector.

   • Certain connectors can be run on either a Sensor or a Data Processor. The available devices are displayed in the Run On menu. If you want to associate your collector with a sensor, you must have configured that sensor prior to configuring the connector or you will not be able to select it during initial configuration. If you select Data Processor, you will need to associate the connector with a Data Analyzer profile as a separate step. That step is not required for a sensor, which is configured with only one possible profile.

   • If the device you're connecting to is on premises, we recommend you run on the local sensor. If you're connecting to a cloud service, we recommend you run on the DP.

10. (Optional) When the Function is Collect, you can apply Log Filters. For information, see Managing Log Filters.

11. Click Next. The Configuration tab appears.

    

    The asterisk (*) indicates a required field.

12. Enter the Host URL you noted above in Configuring Huntress Credentials.

13. Enter the API Key you noted above.

14. Enter the API Secret Key you noted above.

15. Enter the Organization ID you noted above.

16. Choose the Interval (min). This is how often the logs are collected.

    The logs for Agents are queried every 24 hours.

17. Choose the Content Type you would like to collect. The logs for Agents and Incident Reports are supported.

    The Agents content type is always selected and cannot be removed from the configuration as it is required for host information.

18. Click Next. The final confirmation tab appears.

    

19. Click Submit.

    To pull data, a connector must be added to a Data Analyzer profile if it is running on the Data Processor.

20. If you are adding rather than editing a connector with the Collect function enabled and you specified for it to run on a Data Processor, a dialog box now prompts you to add the connector to the default Data Analyzer profile. Click Cancel to leave it out of the default profile or click OK to add it to the default profile.

    • This prompt only occurs during the initial create connector process when Collect is enabled.

    • Certain connectors can be run on either a Sensor or a Data Processor, and some are best run on one versus the other. In any case, when the connector is run on a Data Processor, that connector must be included in a Data Analyzer profile. If you leave it out of the default profile, you must add it to another profile. You need the Administrator Root scope to add the connector to the Data Analyzer profile. If you do not have privileges to configure Data Analyzer profiles, a dialog displays recommending you ask your administrator to add it for you.

    • The first time you add a Collect connector to a profile, it pulls data immediately and then not again until the scheduled interval has elapsed. If the connector configuration dialog did not offer an option to set a specific interval, it is run every five minutes. Exceptions to this default interval are the Proofpoint on Demand (pulls data every 1 hour) and Azure Event Hub (continuously pulls data) connectors. The intervals for each connector are listed in the Connector Types & Functions topic.

    The Connector Overview appears.

The new connector is immediately active.

Partial and Complete Parsing

The information in this section relates to the data enrichment done by the connector where the string under the body field is used to populate fields required for Machine Learning (ML) purposes. But if the size of the body is too large, complete parsing may not be done.

The following threshold levels, T1 and T2, manage data flow and system performance as follows:

• Threshold T1 (500KB)— set to prevent sending large data files through the Stellar Cyber data platform

• Threshold T2 (5MB)—aims to avoid performance and memory issues

The handling of data sizes in relation to these thresholds is as follows:

• For data size S < T1—the body field is retained and complete data parsing is performed

• For T1 ≤ S < T2—data is fully parsed, but the body field is dropped to reduce size

• For S ≥ T2—only partial parsing is conducted and the body field is dropped

Testing the Connector

When you add (or edit) a connector, we recommend that you run a test to validate the connectivity parameters you entered. (The test validates only the authentication / connectivity; it does not validate data flow).

1. Click System | Integrations | Connectors. The Connector Overview appears.

   

2. Locate the connector that you added, or modified, or that you want to test.

3. Click Test at the right side of that row. The test runs immediately.

   Note that you may run only one test at a time.

Verifying Ingestion

To verify ingestion:

1. Click Investigate | Threat Hunting. The Interflow Search tab appears.

2. Change the Indices for the type of content you collected:

   • For Agents and Incident Reports, change the Indices to Syslog.

   • For Agents only, change the Indices to Assets.

   The table immediately updates to show ingested Interflow records.