Configuring BlackBerry Cylance Connectors

The BlackBerry Cylance connector allows you to lock down a device that is associated with an event reported by another connector. In Stellar Cyber, this connector is used for lock down only, not event tracking.

The devices you want to lock down using this connector must be configured using BlackBerry's CylancePROTECT Console to have a policy that permits device control (or to be in a zone configured with a policy that has device control enabled).

Connector Overview: Blackberry Cylance

Capabilities

  • Collect: No

  • Respond: Yes

  • Native Alerts Mapped: Yes

  • Runs on: DP

  • Interval: N/A

Collected Data

N/A

Domain

<Service Endpoint URL>

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

Response Actions

Action

Required Fields

Contain Host

deviceand device.deviceID or cylance and one of cylance.device_id or srcmac or dstmac or (host and host.mac)

Available on Request: The following response actions are available on request via the Universal Webhook Responder:

  • Run Script

  • Add Hash to Global Quarantine

  • Add Hash to Global Safelist

Third Party Native Alert Integration Details

For CylancePROTECT, three types of Cylance events are mapped to the XDR Kill Chain and Stellar Cyber's Alert index: Exploit Attempts, Script Control, and Threats. The other data (Audit Log, Device, Device Control, and Threat Classification) are ingested and mapped to the Syslog index (not Alerts index), and are not run through the ML/SA pipeline.

For CylanceOPTICS, Detection events are evaluated with Stellar Cyber time series analysis models to determine abnormality of the event before mapping.

 For details, see Integration of Third Party Native Alerts.

Required Credentials

  • Service Endpoint URL, Tenant ID, App ID, and App Secret

Locating Records

Use the following to query for records:

  • msg_origin.source: cylance_protect or cylance_optics

  • msg_class: cylance_protect_alert or cylance_optics_event

To search the alerts in the Alerts index or to search the Original Records in the Syslog index, use the query: msg_origin.source:cylance_protect AND event.type:(ExploitAttempt OR ScriptControl OR Threat)

Adding a Blackberry Cylance Connector

To add a Blackberry Cylance connector:

  1. Set up Stellar Cyber in CylancePROTECT and obtain IDs
  2. Add the connector in Stellar Cyber
  3. Test the Connector
  4. Use the Connector

Use our example as a guideline, as you might be using a different software version.

Setting up the Stellar Cyber App Integration

  1. Log in to the CylancePROTECT Console as an administrator.

  2. Select Settings > Integrations.

  3. Click Add Application.

  4. Type an Application Name. This must be unique within your organization.

  5. Select the access privileges for a Console data type. Not selecting any checkboxes for a data type means the application does not have access to that data type.

  6. Click Save.

  7. The credentials to use for the application displays. Make note of both the Application ID and the Application Secret.

  8. Click OK to return to the Integrations tab.

  9. Note that your new application appears in the list. At this point, make note of the Tenant ID that is displayed on the Integrations tab.

    The syntax of the Tenant ID must be exactly as it appears here.

You are now ready to set up your Stellar Cyber Cylance connector.

Adding the Connector in Stellar Cyber

After you have noted the configuration information, you can add the BlackBerry Cylance 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 Blackberry Cylance from the Type drop-down.

  6. For this connector, the supported Function is Respond, 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. Click Next. The Configuration tab appears.

    The asterisk (*) indicates a required field.

  11. Enter the Service Endpoint URL (URL of your regional BlackBerry Cylance portal). Do not append any details to this URL, just the value indicated below for your region:

    Region

    URL

    Asia-Pacific - North

    https://protectapi-apne1.cylance.com/

    Asia-Pacific - Southeast

    https://protectapi-au.cylance.com/

    Europe - Central

    https://protectapi-euc1.cylance.com/

    North America

    https://protectapi.cylance.com/

    South America

    https://protectapi-sae1.cylance.com/

    US Government

    https://protectapi.us.cylance.com/

    For release versions prior to v4.3.4, ensure the URL does not include a trailing "/" symbol.

  12. Enter the Tenant ID you noted earlier.

    The syntax of the Tenant ID must be exactly as it appeared in the Integration tab of the Cylance Console.

  13. Enter the App ID you noted earlier.

  14. Enter the App Secret you noted earlier

  15. Click Next. The final confirmation tab appears.

  16. Click Submit.

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.

Using the Connector to Contain a Host

When an event has occurred on a host known to the BlackBerry Cylance connector, you can use this to isolate the associated host. From the Event list in Investigate | Threat Hunting, you can select the event of interest, then click More Info.  From there, you can select External Action | Endpoint | Contain Host. In the displayed Contain Host Action Configuration block, select the relevant connector and in the Target, specify the source or destination host to lock down.

For more information on working with the events and the actions on them, refer to Understanding Event Details.