Configuring Cybereason Connectors

A Stellar Cyber Cybereason connector allows you to ingest Cybereason MalOp and Sensor data, discover assets, and contain hosts using API calls to the Cybereason server managing those hosts.

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

Capabilities

  • Collect: Yes

  • Respond: Yes

  • Native Alerts Mapped: Yes

  • Runs on: DP

  • Interval: Configurable for MalOp; 24 hrs for Sensor

Collected Data

Content Type

Index

API

Sensor

Assets

Sensor Monitoring

Syslog

https://<server>:port/rest/sensors/query

MalOp

Alerts

Syslog

https://<your server>:port/rest/detection/inbox

Domain

https://<Server>:<Port>

where <Server> and <Port> are variables from the configuration of this connector

Response Actions

Action

Required Fields

API

Contain (Isolate) Host

cybereason.pylumId

https://<your server address>/rest/monitor/global/commands/isolate

https://<your server address>/rest/monitor/global/commands/un-isolate

Third Party Native Alert Integration Details

Sensors

This content is not applicable for alert mapping.

MalOp

Stellar Cyber can generate alerts based on the Cybereason sensor and MalOp data, however the MalOp records are most applicable for direct mapping. The value in malopDetectionType is reformatted and used for the alert name. Stellar Cyber has evaluated each possible alert and assigned a corresponding MITRE | ATT&CK Stage, Tactic and Technique.

 For details, see Integration of Third Party Native Alerts.

Required Credentials

  • Username, Password, Server, and Port

  • User account must have API privileges

Locating Records

Use the following fields as a guide to query for records:

  • msg_origin.vendor: cybereason

  • msg_origin.category: endpoint

MalOp

msg_class: cybereason_malops_all_types

msg_origin.source: cybereason_malops_all_type

prior to v4.3.4

msg_class: cybereason_malops

msg_origin.source: cybereason_malops

Sensors

msg_class: cybereason_sensors

msg_origin.source: cybereason_sensors

Adding a Cybereason Connector

To add a Cybereason connector:

  1. Configure Cybereason API access
  2. Add the connector in Stellar Cyber
  3. Test the connector
  4. Verify ingestion

Configuring Cybereason Access

You must configure Cybereason management before you add the connector in Stellar Cyber and obtain the following details:

  • Username

  • Password

  • Server address and port for API communication

To obtain the information:

  1. Log in to the Cybereason console as an administrative user.

  2. Follow guidance in the Cybereason documentation to ensure the server is enabled for API access.

  3. Create a user account for use with Stellar Cyber connector that has API privileges (refer to "Create a User" in the Cybereason documentation, for example: https://nest.cybereason.com/user/login?destination=/documentation/product-documentation/201/create-edit-and-remove-users) .

    For the Sensor content type, you may need to select the following user roles:

    For details, refer to Required Roles Per Endpoint in the Cybereason documentation.

  4. Make note of the Cybereason username and password before proceeding to the next step.

    The password should not include non-ASCII special characters.

Adding the Connector in Stellar Cyber

To add a Cybereason client 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 Cybereason from the Type drop-down.

  6. Choose the Function: Collect to collect logs; Respond to contain hosts.

  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. Complete this screen with the data you collected from your Cybereason setup steps in the previous section.

    The asterisk (*) indicates a required field.

  12. Enter the Username for use with the API call.

  13. Enter the Password corresponding to that username.

  14. Enter the address of the Cybereason Server receiving API calls (for example: integration.cybereason.net).

  15. Enter the associated Port for that server.

  16. Enter the Interval (min). If you chose Collect, this is how often the logs are collected.

    This interval setting is applicable only for MalOp content; the Sensor content is updated every 24 hours.

  17. Choose the Content Type. The logs for MalOp and Sensor are supported.

    The Sensor content type is required to support Respond actions.

  18. Click Next. The final confirmation tab appears.

  19. Click Submit.

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

  20. 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 to Syslog if you set MalOp as a content type. Use the Assets, Syslog, and Sensor Monitoring indices for the Sensor content type.

    The table immediately updates to show ingested Interflow records.

You can also find assets from Cybereason Sensor content reported in the Investigate | Asset Analytics | IP Identified Assets view.

If you configured the connector Respond actions, refer to External Actions: Contain Host to understand how to work with the Contain Host feature.