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

Capabilities

  • Collect: Yes

  • Respond: No

  • Native Alerts Mapped: No

  • Runs on: DP

  • Interval: Configurable

Collected Data

Content Type

Index

Locating Records

Incidents

Audit Trail Logs

Devices

Syslog

Assets (for Devices)

msg_class:

canary_incidents

canary_audit

canary_devices

msg_origin.source:

thinkst_canary

msg_origin.vendor:

thinkst_canary

msg_origin.category:

honeypot

Domain

https:/<Hostname>

where <Hostname> is a variable from the configuration of this connector

Response Actions

N/A

Third Party Native Alert Integration Details

N/A

Required Credentials

  • Hostname (Domain Hash) and Authentication token

               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.

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

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

For connectors running on a sensor, Stellar Cyber recommends that you allow 30-60 seconds for new or modified configuration details to be propagated to the sensor before performing a test.

  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.

Stellar Cyber conducts a basic connectivity test for the connector and reports a success or failure result. A successful test indicates that you entered all of the connector information correctly.

To aid troubleshooting your connector, the dialog remains open until you explicitly close it by using the X button. If the test fails, you can select the  button from the same row to review and correct issues.

The connector status is updated every five (5) minutes. A successful test clears the connector status, but if issues persist, the status reverts to failed after a minute.

Repeat the test as needed.

ClosedDisplay sample messages...

Success !

Failure with summary of issue:

Show More example detail:

If the test fails, the common HTTP status error codes are as follows:

HTTP Error Code HTTP Standard Error Name Explanation Recommendation
400 Bad Request This error occurs when there is an error in the connector configuration.

Did you configure the connector correctly?
401 Unauthorized

This error occurs when an authentication credential is invalid or when a user does not have sufficient privileges to access a specific API.

Did you enter your credentials correctly?

Are your credentials expired?

Are your credentials entitled or licensed for that specific resource?
403 Forbidden This error occurs when the permission or scope is not correct in a valid credential.

Did you enter your credentials correctly?

Do you have the required role or permissions for that credential?

404 Not Found This error occurs when a URL path does not resolve to an entity. Did you enter your API URL correctly?
429 Too Many Requests

This error occurs when the API server receives too much traffic or if a user’s license or entitlement quota is exceeded.

The server or user license/quota will eventually recover. The connector will periodically retry the query.

If this occurs unexpectedly or too often, work with your API provider to investigate the server limits, user licensing, or quotas.

For a full list of codes, refer to HTTP response status codes.

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 Audit Trail Logs, Devices, and Incidents, change the Indices to Syslog.

    • For Devices only, change the Indices to Assets.

    The table immediately updates to show ingested Interflow records.