Configuring Thinkst Canary Connectors

This connector allows Stellar Cyber to ingest logs from Thinkst Canary and add the records to the data lake.

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: Thinkst Canary

               Let us know if you find the above overview useful.

Adding a Thinkst Canary Connector

To add a Thinkst Canary connector:

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

Obtaining Thinkst Canary Credentials

Follow guidance on Thinkst Canary documentation to enable the API and generate an API token for Stellar Cyber API calls.

1. Login as an administrative user to the Thinkst Canary console.

2. Click the Gear icon and select Global Settings.

3. Click API and select Enable API.

4. Note the Auth Token and Domain Hash in the dialog box. The Auth Token is the API key to make calls. The Domain Hash identifies your Console when using the API.

   

5. Create the hostname for Stellar Cyber in the following format: <domain hash>.canary.tools

Adding the Connector in Stellar Cyber

With the access information handy, you can add a Thinkst Canary 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 Honeypot from the Category drop-down.

5. Choose Thinkst Canary 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. This identifies the tenant that is allowed to use the connector.

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 create Log Filters. For information, see Managing Log Filters.

11. Click Next. The Configuration tab appears.

    

    The asterisk (*) indicates a required field.

12. Enter the Hostname using the information you noted above.

    Do not include https in the Hostname.

13. Enter the Auth Token you noted above.

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

    The logs for Devices are queried every 24 hours.

15. Choose the Content Type. The logs for Audit Trail Logs, Devices, and Incidents are supported.

16. Click Next. The final confirmation tab appears.

    

17. Click Submit.

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

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

Display sample messages...

Success !

Failure with summary of issue: Show More example detail:

 

Verifying Ingestion

To verify ingestion:

1. Click Investigate | Threat Hunting. The Interflow Search tab appears.
2. Change the Indices to Syslog or for the Devices content type only, change the Indices to Assets. The table immediately updates to show ingested Interflow records.