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.

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: LimaCharlie

Capabilities

  • Collect: Yes

  • Respond: No

  • Native Alerts Mapped: Yes

  • 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

This connector ingests logs from LimaCharlie to get the raw alerts that are stored in the Syslog index. Select the Alerts content type.

Stellar Cyber maps LimaCharlie alerts. The alerts are read from the Syslog index, enriched with Stellar Cyber fields, and mapped (with deduplication) to the Alerts index.

The following types of events for alerts collected by LimaCharlie's EDR sensors are supported: Process Events, Logon Events, and FIM Events.

Deduplication is by tenantid and limacharlie.routing.event_id.

Tactic and Technique are provided by the LimaCharlie raw alerts field limacharlie.detect_mtd.tags.

For details, see Integration of Third Party Native Alerts.

Required Credentials

  • Host URL, OID, and API Key

Locating Records

To search the alerts in the Alerts index, use the query: msg_class: limacharlie_alert AND _exists_: limacharlie.routing.sid. The _exists_: limacharlie.routing.sid is added to identify the alerts generated by LimaCharlie's EDR sensors.

To search the Original Records in the Syslog index, use the query: msg_class: limacharlie_alert

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

    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 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 from the configuration as it is required for host information. 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.

  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.

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

    • For LimaCharlie Sensors only, change the Indices to Assets.

    The table immediately updates to show ingested Interflow records.