Configuring LimaCharlie Connectors

This connector allows Stellar Cyber to ingest logs from LimaCharlie and add the records to the data lake. It integrates with the LimaCharlie API to query for alerts.

Connector Overview: LimaCharlie

Capabilities

  • Collect: Yes

  • Respond: No

  • Native Alerts Mapped: No

  • Runs on: DP

  • Interval: Configurable

Collected Data

Content Type

Index

Locating Records

Alerts

Sensors (not configurable; logs are automatically collected every 24 hours)

Syslog

Assets (for Sensors)

msg_class:

limacharlie_alert

limacharlie_sensor

msg_origin.source:

limacharlie

msg_origin.vendor:

limacharlie

msg_origin.category:

endpoint

Domain

<Host URL>

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

Response Actions

N/A

Third Party Native Alert Integration Details

N/A

Required Credentials

  • Host URL, OID, and API Key

               Let us know if you find the above overview useful.

Adding a LimaCharlie Connector

To add a LimaCharlie connector:

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

Obtaining LimaCharlie Credentials

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

  • OID

  • API Key

  1. Log in to LimaCharlie as an administrative user.

  2. Select your organization.

  3. Expand Access Management, choose REST API, and locate the OID.

  4. Click Create API Key.

  5. Enable the following permissions: sensor.get, sensor.list, and sensor.task.

  6. Enter a name for the API key and click Create.

  7. Copy the API key.

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

Adding the Connector in Stellar Cyber

To add a LimaCharlie 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 LimaCharlie 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.

  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 Host URL for the API server, for example: https://api.limacharlie.io/v1.

  13. Enter the OID you noted above in Obtaining LimaCharlie Credentials.

  14. Enter the API Key you noted above in Obtaining LimaCharlie Credentials.

  15. Choose the Interval (min). This is how often the logs are collected. The default interval is 5 minutes.

    The logs for LimaCharlie sensors are queried every 24 hours.

  16. Choose the Content Type you would like to collect. The logs for Alerts and Sensors are supported.

    The Sensors content type is always selected and cannot be removed. LimaCharlie sensors are not configurable and are automatically pulled.

  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.

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:

 

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 alerts, change the Indices to Syslog.

    • For LimaCharlie sensors, change the Indices to Assets.

    The table immediately updates to show ingested Interflow records.