VMware Carbon Black Cloud Platform Alerts CDF
The web format of this guide reflects the most current release. Guides for older iterations are available in PDF format.
Integration Details
ThreatQuotient provides the following details for this integration:
Current Integration Version | 1.0.3 |
Compatible with ThreatQ Versions | >= 4.25.0 |
Support Tier | ThreatQ Supported |
Introduction
The VMWare Carbon Black Cloud Platform Alerts CDF for ThreatQ allows a user to ingest alerts from their Carbon Black Cloud instance in ThreatQ.
Installation
This integration can be installed in the My Integration section of your ThreatQ instance. See the Adding an Integration topic for more details.
Configuration
ThreatQuotient does not issue API keys for third-party vendors. Contact the specific vendor to obtain API keys and other integration-related credentials.
To configure the integration:
- Navigate to your integrations management page in ThreatQ.
- Select the Commercial option from the Category dropdown (optional).
If you are installing the integration for the first time, it will be located under the Disabled tab.
- Click on the integration entry to open its details page.
- Enter the following parameters under the Configuration tab:
Parameter Description Carbon Black Cloud Platform API Host Enter the FQDN for your Carbon Black Cloud Platform instance (i.e., without protocol). Organization Key Your Organization Key, as displayed in the Carbon Black Cloud Platform instance. API Key Your API ID, as displayed in the Carbon Black Cloud Platform instance. API Secret Key Your API Secret Key, as displayed in the Carbon Black Cloud Platform instance. Query An optional Carbon Black search query to filter the incoming alerts. See the Carbon Black documentation for information on how to write a Carbon Black query. Minimum Severity The minimum severity for an alert to be ingested in ThreatQ. Target Values One or more target values to filter the incoming alerts. Categories One or more categories to filter the incoming alerts. - Review any additional settings, make any changes if needed, and click on Save.
- Click on the toggle switch, located above the Additional Information section, to enable it.
ThreatQ Mapping
VMWare Carbon Black Cloud Platform Alerts
This feed will ingest alerts as incidents from a VMware Carbon Black Cloud instance. It will also ingest and relate any indicators, MITRE ATT&CK Attack Patterns, and TTPs.
GET https://{{user_fields.api_host}}/appservices/v6/orgs/{{user_fields.org_key}}/alerts/_search
Sample Response:
{
"num_found": 107,
"results": [
{
"blocked_threat_category": "UNKNOWN",
"category": "MONITORED",
"create_time": "2020-04-13T12:56:25.905Z",
"created_by_event_id": "2a18cf757d8611eababcb989b304c3ec",
"device_id": 3350047,
"device_location": "OFFSITE",
"device_name": "GL-AV-731XM-1",
"device_os": "WINDOWS",
"device_os_version": "Server 2012 R2 x64",
"device_username": "sakshi.rawal@logrhythm.com",
"first_event_time": "2020-04-13T12:55:30.768Z",
"group_details": {
"count": 1,
"total_devices": 1
},
"id": "33500472a18cf757d8611eababcb989b304c3ec",
"kill_chain_status": [
"INSTALL_RUN"
],
"last_event_time": "2020-04-13T12:55:30.768Z",
"last_update_time": "2020-04-13T12:56:25.905Z",
"legacy_alert_id": "QME48KBB",
"not_blocked_threat_category": "NON_MALWARE",
"notes_present": false,
"org_key": "7DESJ9GN",
"policy_applied": "NOT_APPLIED",
"policy_id": 36161,
"policy_name": "documentation CB5788",
"process_name": "java.exe",
"reason": "A hidden process for java.exe has been detected. This may indicate the presence of a Rootkit.",
"reason_code": "R_HIDDEN",
"run_state": "RAN",
"sensor_action": null,
"severity": 4,
"tags": null,
"target_value": "LOW",
"threat_activity_c2": "NOT_ATTEMPTED",
"threat_activity_dlp": "NOT_ATTEMPTED",
"threat_activity_phish": "NOT_ATTEMPTED",
"threat_cause_actor_name": null,
"threat_cause_actor_process_pid": "79792-132312531086826897-0",
"threat_cause_actor_sha256": "fafc81c87ae51525893d7e77c52f1aaed9444f1cb8f67601ba23c7e0530ee5db",
"threat_cause_cause_event_id": "2a18cf757d8611eababcb989b304c3ec",
"threat_cause_reputation": "TRUSTED_WHITE_LIST",
"threat_cause_threat_category": "NON_MALWARE",
"threat_cause_vector": "UNKNOWN",
"threat_id": "992881090b32cabfa37ab44be4d419b2",
"threat_indicators": [
{
"process_name": "java.exe",
"sha256": "fafc81c87ae51525893d7e77c52f1aaed9444f1cb8f67601ba23c7e0530ee5db",
"ttps": [
"MITRE_T1158_HIDDEN_FILES_AND_DIRECTORIES"
]
},
{
"process_name": "java.exe",
"sha256": "fafc81c87ae51525893d7e77c52f1aaed9444f1cb8f67601ba23c7e0530ee5db",
"ttps": [
"HIDDEN_PROCESS"
]
}
],
"type": "CB_ANALYTICS",
"workflow": {
"changed_by": "Carbon Black",
"comment": null,
"last_update_time": "2020-04-13T12:56:25.905Z",
"remediation": null,
"state": "OPEN"
}
},
{
"blocked_threat_category": "NON_MALWARE",
"category": "THREAT",
"create_time": "2020-04-10T19:25:18.779Z",
"created_by_event_id": "fe021e807b6011ea8b807b3f272bca5a",
"device_id": 3238121,
"device_location": "OFFSITE",
"device_name": "DESKTOP-7I73LFA",
"device_os": "WINDOWS",
"device_os_version": "Windows 10 x64",
"device_username": "rfortress@vmware.com",
"first_event_time": "2020-04-10T19:23:15.464Z",
"group_details": {
"count": 3,
"total_devices": 1
},
"id": "3238121fe021e807b6011ea8b807b3f272bca5a",
"kill_chain_status": [
"INSTALL_RUN"
],
"last_event_time": "2020-04-12T23:18:42.072Z",
"last_update_time": "2020-04-10T19:26:20.740Z",
"legacy_alert_id": "HNZW3ZEZ",
"not_blocked_threat_category": "UNKNOWN",
"notes_present": false,
"org_key": "7DESJ9GN",
"policy_applied": "APPLIED",
"policy_id": 6529,
"policy_name": "Restrictive_Windows_Workstation",
"process_name": "sample.exe",
"reason": "The application sample.exe was detected running. A Terminate Policy Action was applied.",
"reason_code": "T_POL_TERM : sample.exe",
"run_state": "RAN",
"sensor_action": "DENY",
"severity": 3,
"tags": null,
"target_value": "MEDIUM",
"threat_activity_c2": "NOT_ATTEMPTED",
"threat_activity_dlp": "NOT_ATTEMPTED",
"threat_activity_phish": "NOT_ATTEMPTED",
"threat_cause_actor_name": null,
"threat_cause_actor_process_pid": "5180-1585321534989-1",
"threat_cause_actor_sha256": "87e2a0bec31622be040c81657fb1dfac1624a854e9e78abf88edcc078a322298",
"threat_cause_cause_event_id": "fe021e807b6011ea8b807b3f272bca5a",
"threat_cause_reputation": "NOT_LISTED",
"threat_cause_threat_category": "NEW_MALWARE",
"threat_cause_vector": "UNKNOWN",
"threat_id": "e9f3d0e42410a0effd5aab1648db9653",
"threat_indicators": [
{
"process_name": "explorer.exe",
"sha256": "c5e88d778c0b118d49bef467ed059c09b61deea505d2a3d5ca1dcc0a5cdf752f",
"ttps": [
"POLICY_DENY"
]
},
{
"process_name": "explorer.exe",
"sha256": "c5e88d778c0b118d49bef467ed059c09b61deea505d2a3d5ca1dcc0a5cdf752f",
"ttps": [
"RUN_UNKNOWN_APP"
]
},
{
"process_name": "sample.exe",
"sha256": "87e2a0bec31622be040c81657fb1dfac1624a854e9e78abf88edcc078a322298",
"ttps": [
"UNKNOWN_APP"
]
},
{
"process_name": "sample.exe",
"sha256": "87e2a0bec31622be040c81657fb1dfac1624a854e9e78abf88edcc078a322298",
"ttps": [
"POLICY_TERMINATE"
]
}
],
"type": "CB_ANALYTICS",
"workflow": {
"changed_by": "Carbon Black",
"comment": null,
"last_update_time": "2020-04-10T19:25:18.779Z",
"remediation": null,
"state": "OPEN"
}
}
]
}
ThreatQ provides the following default mapping for this feed:
Feed Data Path | ThreatQ Entity | ThreatQ Object Type or Attribute Key | Published Date | Examples | Notes |
---|---|---|---|---|---|
.results[].reason | Incident.Value | Incident | .results[].created_time | Alert: Recorded Future - 2020-07-05T18:35:33.808Z | The creation time of the alert is concatenated to the "reason" |
.results[].first _event_time |
Incident.StartedAt | N/A | N/A | 2020-07-05T18:35:33.080Z | N/A |
.results[].last _event_time |
Incident.EndedAt | N/A | N/A | 2020-07-05T18:35:33.080Z | N/A |
.results[].category | Indicator.Attribute, Incident.Attribute | Category | .results[].created_time | THREAT | UNKNOWN values are not ingested |
.results[].kill_ chain_status[] |
Indicator.Attribute, Incident.Attribute | Kill Chain Status | .results[].created_time | INSTALL_RUN | N/A |
.results[].severity | Indicator.Attribute, Incident.Attribute | Severity | .results[].created_time | 9 | N/A |
.results[].tags[] | Indicator.Attribute, Incident.Attribute | Tag | .results[].created_time | .results[].created_time | N/A |
.results[].target_value | Indicator.Attribute, Incident.Attribute | Target Value | .results[].created_time | HIGH | UNKNOWN values are not ingested |
.results[].threat_ activity_c2 |
Indicator.Attribute, Incident.Attribute | C2 Activity | .results[].created_time | Yes | UNKNOWN values are not ingested |
.results[].threat_ activity_dlp |
Indicator.Attribute, Incident.Attribute | DLP Activity | .results[].created_time | No | UNKNOWN values are not ingested |
.results[].threat_ activity_phish |
Indicator.Attribute, Incident.Attribute | Phishing Activity | .results[].created_time | No | UNKNOWN values are not ingested |
.results[].threat_ cause_reputation |
Indicator.Attribute, Incident.Attribute | Threat Cause Reputation | .results[].created_time | ADAPTIVE_WHITE_LIST | UNKNOWN values are not ingested |
.results[].threat_cause _threat_category |
Indicator.Attribute, Incident.Attribute | Threat Cause Threat Category | .results[].created_time | NEW_MALWARE | UNKNOWN values are not ingested |
.results[].threat_cause _actor_name |
Indicator.Attribute, Incident.Attribute | Threat Cause Actor Name | .results[].created_time | Virus: Mimikatz | N/A |
.results[].threat _cause_vector |
Indicator.Attribute, Incident.Attribute | Threat Cause Vector | .results[].created_time | WEB | N/A |
.results[].blocked _threat_category |
Indicator.Attribute, Incident.Attribute | Blocked Threat Category | .results[].created_time | NEW_MALWARE | UNKNOWN values are not ingested |
.results[].device_id | Incident.Attribute | Device ID | .results[].created_time | 12345 | N/A |
.results[].device_location | Incident.Attribute | Device Location | .results[].created_time | OFFSITE | UNKNOWN values are not ingested |
.results[].device_name | Incident.Attribute | Device Name | .results[].created_time | GL-AV-731XM-1 | UNKNOWN values are not ingested |
.results[].device_os | Incident.Attribute | Device Operating System | .results[].created_time | WINDOWS | UNKNOWN values are not ingested |
.results[].device_os_version | Incident.Attribute | Device Operating System Version | .results[].created_time | Server 2012 R2 x64 | UNKNOWN values are not ingested |
.results[].device_username | Incident.Attribute | Device Username | .results[].created_time | sakshi.rawal@logrhythm.com | UNKNOWN values are not ingested |
.results[].not_blocked _threat_category |
Indicator.Attribute Incident.Attribute |
Not Blocked Threat Category | .results[].created_time | NON_MALWARE | N/A |
.results[].policy_applied | Incident.Attribute | Policy Applied | .results[].created_time | Yes | Always one of Yes , No , converted from APPLIED or NOT APPLIED ; UNKNOWN values are not ingested |
.results[].policy_name | Incident.Attribute | Policy Name | .results[].created_time | documentation CB5788 | UNKNOWN values are not ingested |
.results[].reason | Incident.Attribute | Reason | .results[].created_time | Recorded Future | UNKNOWN values are not ingested |
.results[].reason_code | Incident.Attribute | Reason Code | .results[].created_time | R_HIDDEN | UNKNOWN values are not ingested |
.results[].run_state | Incident.Attribute | Run State | .results[].created_time | RAN | UNKNOWN values are not ingested |
.results[].sensor_action | Incident.Attribute | Sensor Action | .results[].created_time | DENY | N/A |
.results[].threat_indicators [].process_name |
Incident.Attribute | Process Involved | .results[].created_time | explorer.exe | N/A |
.results[].type | Incident.Attribute | Carbon Black Type | .results[].created_time | CB_ANALYTICS | N/A |
.results[].group_details.count | Incident.Attribute | Group Count | .results[].created_time | 2 | N/A |
.results[].first_event_time | Incident.Attribute | First Event Time | .results[].created_time | 2020-07-05T18:35:33.080Z | N/A |
.results[].id | Incident.Attribute | Alert Link | .results[].created_time | N/A | Formatted from user fields and response data |
.results[].threat_cause _actor_sha256 |
Indicator.Value | SHA-256 | .results[].created_time | FA4F71314F1D8587604B79 149880618B95017F0CCF11 E2DDC372BCCC32A7CF8B |
N/A |
.results[].threat_ indicators[].ttps[] |
AttackPattern.Value | Attack Pattern | N/A | T1075 - Pass the Hash | Only related to an Incident if the ThreatQ instance has available MITRE ATT&CK Attack Pattern data. |
.results[].threat_ indicators[].ttps[] |
TTP.Value | TTP | N/A | RUN_UNKNOWN_APP | Non-MITRE Attack TTPs |
.results[].threat_ indicators[].sha256 |
Related Indicator.Value | SHA-256 | results[].created_time | c5e88d778c0b118d49 bef467ed059c09b61d eea505d2a3d5ca1dcc 0a5cdf752f |
Average Feed Run
Object counts and Feed runtime are supplied as generalities only - objects returned by a provider can differ based on credential configurations and Feed runtime may vary based on system resources and load.
VMWare Carbon Black Cloud Platform Alerts
Average Feed Run results for VMWare Carbon Black Cloud Platform Alerts (with minimum severity = 5, and all categories and target values selected):
Metric | Result |
---|---|
Run Time | < 2 minutes |
Indicators | 17 |
Indicator Attributes | 123 |
Incidents | 55 |
Incident Attributes | 1,050 |
TTPs | 70 |
Known Issues / Limitations
MITRE ATT&CK attack patterns must have already been ingested by a previous run of the MITRE ATT&CK feeds in order for MITRE ATT&CK attack patterns extracted from an Incident to be related to the Incident object. MITRE ATT&CK attack patterns are ingested from the following feeds:
- MITRE Enterprise ATT&CK
- MITRE Mobile ATT&CK
- MITRE PRE-ATT&CK
Change Log
- Version 1.0.3
- Updated attributes.
- Added new SHA-256 indicators.
- Version 1.0.2
- Deleted empty request parameter which resulted in API error response.
- Version 1.0.1
- Change UI configuration parameter from
Organization ID
toOrganization Key
- Change UI configuration parameter from
- Version 1.0.0
- Initial release
PDF Guides
Document | ThreatQ Version |
---|---|
VMware Carbon Black Cloud Platform Alerts Guide v1.0.3 | 4.25.0 or Greater |
VMware Carbon Black Cloud Platform Alerts Guide v1.0.2 | 4.25.0 or Greater |
VMware Carbon Black Cloud Platform Alerts Guide v1.0.1 | 4.25.0 or Greater |
VMware Carbon Black Cloud Platform Alerts Guide v1.0.0 | 4.25.0 or Greater |