Configuring HYAS Protect Connectors

This connector allows Stellar Cyber to ingest logs from HYAS Protect and add the records to the data lake. This connector integrates with the HYAS Protect API to query for DNS log reports. It supports ingesting records, generating assets, and alerting on data from HYAS Protect to monitor DNS logs using the Stellar Cyber platform.

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: HYAS Protect

Adding a HYAS Protect Connector

To add a HYAS Protect connector:

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

Obtaining HYAS Protect Credentials

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

• Base URL: The default is https://api.hyas.com.

• API Key

• (Optional) Client ID

Obtaining API Key

The API Key is emailed to you when you create a user account.

To create a user:

1. Log in as an Administrator to the HYAS Protect UI.

2. Click the Settings (gear) icon, and then select Manage User Accounts.

   

3. Select + and then add the user email and other selections.

   

4. From the API Key drop down, select Generate Key.

5. Click Save.

6. The user will receive an email with login instructions, such as the following:

   

   Store the API Key in a safe location. It cannot be retrieved later although you can request a new one.

Obtaining Client ID

The client ID is a unique identifier for each organization. API endpoints may require the client ID to identify for which organization the data is being requested.

To obtain the Client ID:

1. In the HYAS Protect UI, click the Settings (gear) icon, and then select Protect Agent.

   

2. In the HYAS Protect Agent Dashboard, select Install.

3. Copy your Install Key.

   Install Key = Client ID.

Adding the Connector in Stellar Cyber

To add a HYAS connector in Stellar Cyber:

1. Log in to Stellar Cyber.

2. Click System | Connectors (under Integrations). 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 DNS Security from the Category drop-down.

5. Choose HYAS Protect from the Type drop-down.

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

7. Enter a Name.

   Notes:

   • This field does not accept multibyte characters.
   • It is recommended that you follow a naming convention such as tenantname-connectortype.

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 Base URL you noted above in Obtaining HYAS Protect Credentials.

13. Enter the API Key you noted above in Obtaining API Key.

14. (Optional) Enter the Client ID you noted above in Obtaining Client ID.

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

16. Choose the Content Type you would like to collect. The logs for Agents and DNS Log Reports are supported.

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

17. Click Next. The final confirmation tab appears.

    

18. Click Submit.

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

19. 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.

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 authentication and connectivity).

1. Click System | Connectors (under Integrations). The Connector Overview appears.

   

2. Locate the connector by name 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 DNS Log Reports, change the Indices to Syslog.

   • For Agents only, change the Indices to Assets.

   The table immediately updates to show ingested Interflow records.