A Detection Finding describes detections or alerts generated by security products using correlation engines, detection engines or other methodologies. Note: if the product is a security control, the security_control profile should be applied and its attacks information should be duplicated into the finding_info object.
- Category: Findings
- Extends:
finding - UID:
2004
Attributes
Section titled “Attributes”Classification
Section titled “Classification”activity_id
- Type:
integer_t - Requirement: required
- Values:
0-Unknown: The event activity is unknown.1-Create: A finding was created.2-Update: A finding was updated.3-Close: A finding was closed.99-Other: The event activity is not mapped. See theactivity_nameattribute, which contains a data source specific value.
The normalized identifier of the finding activity.
category_uid
- Type:
integer_t - Requirement: required
- Values:
2-Findings: Findings events report findings, detections, and possible resolutions of malware, anomalies, or other actions performed by security products.
The category unique identifier of the event.
class_uid
- Type:
integer_t - Requirement: required
- Values:
2004-Detection Finding: A Detection Finding describes detections or alerts generated by security products using correlation engines, detection engines or other methodologies. Note: if the product is a security control, thesecurity_controlprofile should be applied and itsattacksinformation should be duplicated into thefinding_infoobject.
The unique identifier of a class. A Class describes the attributes available in an event.
severity_id
- Type:
integer_t - Requirement: required
- Values:
0-Unknown: The event/finding severity is unknown.1-Informational: Informational message. No action required.2-Low: The user decides if action is needed.3-Medium: Action is required but the situation is not serious at this time.4-High: Action is required immediately.5-Critical: Action is required immediately and the scope is broad.6-Fatal: An error occurred but it is too late to take remedial action.99-Other: The event/finding severity is not mapped. See theseverityattribute, which contains a data source specific value.
The normalized identifier of the event/finding severity.The normalized severity is a measurement the effort and expense required to manage and resolve an event or incident. Smaller numerical values represent lower impact events, and larger numerical values represent higher impact events.
type_uid
- Type:
long_t - Requirement: required
- Values:
200400-Detection Finding: Unknown200401-Detection Finding: Create: A finding was created.200402-Detection Finding: Update: A finding was updated.200403-Detection Finding: Close: A finding was closed.200499-Detection Finding: Other
The event/finding type ID. It identifies the event’s semantics and structure. The value is calculated by the logging system as: class_uid * 100 + activity_id.
activity_name
- Type:
string_t - Requirement: optional
The finding activity name, as defined by the activity_id.
category_name
- Type:
string_t - Requirement: optional
The event category name, as defined by category_uid value: Findings.
class_name
- Type:
string_t - Requirement: optional
The event class name, as defined by class_uid value: Detection Finding.
severity
- Type:
string_t - Requirement: optional
The event/finding severity, normalized to the caption of the severity_id value. In the case of ‘Other’, it is defined by the source.
type_name
- Type:
string_t - Requirement: optional
The event/finding type name, as defined by the type_uid.
Context
Section titled “Context”metadata
- Type:
metadata - Requirement: required
The metadata associated with the event or a finding.
confidence_id
- Type:
integer_t - Requirement: recommended
- Values:
0-Unknown: The normalized confidence is unknown.1-Low2-Medium3-High99-Other: The confidence is not mapped to the defined enum values. See theconfidenceattribute, which contains a data source specific value.
The normalized confidence refers to the accuracy of the rule that created the finding. A rule with a low confidence means that the finding scope is wide and may create finding reports that may not be malicious in nature.
resources
- Type:
resource_details - Requirement: recommended
Describes details about resources that were the target of the activity that triggered the finding.
status_id
- Type:
integer_t - Requirement: recommended
- Values:
0-Unknown: The status is unknown.1-New: The Finding is new and yet to be reviewed.2-In Progress: The Finding is under review.3-Suppressed: The Finding was reviewed, determined to be benign or a false positive and is now suppressed.4-Resolved: The Finding was reviewed, remediated and is now considered resolved.99-Other: The event status is not mapped. See thestatusattribute, which contains a data source specific value.
The normalized status identifier of the Finding, set by the consumer.
api cloud
- Type:
api - Requirement: optional
Describes details about a typical API (Application Programming Interface) call.
comment
- Type:
string_t - Requirement: optional
A user provided comment about the finding.
confidence
- Type:
string_t - Requirement: optional
The confidence, normalized to the caption of the confidence_id value. In the case of ‘Other’, it is defined by the event source.
confidence_score
- Type:
integer_t - Requirement: optional
The confidence score as reported by the event source.
enrichments
- Type:
enrichment - Requirement: optional
The additional information from an external data source, which is associated with the event or a finding. For example add location information for the IP address in the DNS answers:[{"name": "answers.ip", "value": "92.24.47.250", "type": "location", "data": {"city": "Socotra", "continent": "Asia", "coordinates": [-25.4153, 17.0743], "country": "YE", "desc": "Yemen"}}]
impact
- Type:
string_t - Requirement: optional
The impact , normalized to the caption of the impact_id value. In the case of ‘Other’, it is defined by the event source.
impact_id
- Type:
integer_t - Requirement: optional
- Values:
0-Unknown: The normalized impact is unknown.1-Low2-Medium3-High4-Critical99-Other: The impact is not mapped. See theimpactattribute, which contains a data source specific value.
The normalized impact of the finding.
impact_score
- Type:
integer_t - Requirement: optional
The impact of the finding, valid range 0-100.
raw_data
- Type:
string_t - Requirement: optional
The raw event/finding data as received from the source.
remediation
- Type:
remediation - Requirement: optional
Describes the recommended remediation steps to address identified issue(s).
risk_level
- Type:
string_t - Requirement: optional
The risk level, normalized to the caption of the risk_level_id value. In the case of ‘Other’, it is defined by the event source.
risk_level_id
- Type:
integer_t - Requirement: optional
- Values:
0-Info1-Low2-Medium3-High4-Critical
The normalized risk level id.
risk_score
- Type:
integer_t - Requirement: optional
The risk score as reported by the event source.
status
- Type:
string_t - Requirement: optional
The normalized status of the Finding set by the consumer normalized to the caption of the status_id value. In the case of ‘Other’, it is defined by the source.
unmapped
- Type:
object - Requirement: optional
The attributes that are not mapped to the event schema. The names and values of those attributes are specific to the event source.
vulnerabilities
- Type:
vulnerability - Requirement: optional
Describes vulnerabilities reported in a Detection Finding.
Occurrence
Section titled “Occurrence”time
- Type:
timestamp_t - Requirement: required
The normalized event occurrence time or the finding creation time.
timezone_offset
- Type:
integer_t - Requirement: recommended
The number of minutes that the reported event time is ahead or behind UTC, in the range -1,080 to +1,080.
count
- Type:
integer_t - Requirement: optional
The number of times that events in the same logical group occurred during the event Start Time to End Time period.
duration
- Type:
integer_t - Requirement: optional
The event duration or aggregate time, the amount of time the event covers from start_time to end_time in milliseconds.
end_time
- Type:
timestamp_t - Requirement: optional
The time of the most recent event included in the finding.
end_time_dt datetime
- Type:
datetime_t - Requirement: optional
The time of the most recent event included in the finding.
start_time
- Type:
timestamp_t - Requirement: optional
The time of the least recent event included in the finding.
start_time_dt datetime
- Type:
datetime_t - Requirement: optional
The time of the least recent event included in the finding.
time_dt datetime
- Type:
datetime_t - Requirement: optional
The normalized event occurrence time or the finding creation time.
Primary
Section titled “Primary”action_id security_control
- Type:
integer_t - Requirement: required
- Values:
0-Unknown: The action was unknown. Thedisposition_idattribute may still be set to a non-unknown value, for example ‘Count’, ‘Uncorrected’, ‘Isolated’, ‘Quarantined’ or ‘Exonerated’.1-Allowed: The activity was allowed. Thedisposition_idattribute should be set to a value that conforms to this action, for example ‘Allowed’, ‘Approved’, ‘Delayed’, ‘No Action’, ‘Count’ etc.2-Denied: The attempted activity was denied. Thedisposition_idattribute should be set to a value that conforms to this action, for example ‘Blocked’, ‘Rejected’, ‘Quarantined’, ‘Isolated’, ‘Dropped’, ‘Access Revoked, etc.99-Other: The action was not mapped. See theactionattribute, which contains a data source specific value.
The action taken by a control or other policy-based system leading to an outcome or disposition. Dispositions conform to an action of 1 ‘Allowed’ or 2 ‘Denied’ in most cases. Note that 99 ‘Other’ is not an option. No action would equate to 1 ‘Allowed’. An unknown action may still correspond to a known disposition. Refer to disposition_id for the outcome of the action.
cloud cloud
- Type:
cloud - Requirement: required
Describes details about the Cloud environment where the event was originally created or logged.
finding_info
- Type:
finding_info - Requirement: required
Describes the supporting information about a generated finding.
disposition_id security_control
- Type:
integer_t - Requirement: recommended
- Values:
0-Unknown: The disposition was not known.1-Allowed: Granted access or allowed the action to the protected resource.2-Blocked: Denied access or blocked the action to the protected resource.3-Quarantined: A suspicious file or other content was moved to a benign location.4-Isolated: A session was isolated on the network or within a browser.5-Deleted: A file or other content was deleted.6-Dropped: The request was detected as a threat and resulted in the connection being dropped.7-Custom Action: A custom action was executed such as running of a command script. Use themessageattribute of the base class for details.8-Approved: A request or submission was approved. For example, when a form was properly filled out and submitted. This is distinct from1‘Allowed’.9-Restored: A quarantined file or other content was restored to its original location.10-Exonerated: A suspicious or risky entity was deemed to no longer be suspicious (re-scored).11-Corrected: A corrupt file or configuration was corrected.12-Partially Corrected: A corrupt file or configuration was partially corrected.13-Uncorrected: A corrupt file or configuration was not corrected.14-Delayed: An operation was delayed, for example if a restart was required to finish the operation.15-Detected: Suspicious activity or a policy violation was detected without further action.16-No Action: The outcome of an operation had no action taken.17-Logged: The operation or action was logged without further action.18-Tagged: A file or other entity was marked with extended attributes.19-Alert: The request or activity was detected as a threat and resulted in a notification but request was not blocked.20-Count: Counted the request or activity but did not determine whether to allow it or block it.21-Reset: The request was detected as a threat and resulted in the connection being reset.22-Captcha: Required the end user to solve a CAPTCHA puzzle to prove that a human being is sending the request.23-Challenge: Ran a silent challenge that required the client session to verify that it’s a browser, and not a bot.24-Access Revoked: The requestor’s access has been revoked due to security policy enforcements. Note: use theHostprofile if theUserorActorrequestor is not present in the event class.25-Rejected: A request or submission was rejected. For example, when a form was improperly filled out and submitted. This is distinct from2‘Blocked’.26-Unauthorized: An attempt to access a resource was denied due to an authorization check that failed. This is a more specific disposition than2‘Blocked’ and can be complemented with theauthorizationsattribute for more detail.27-Error: An error occurred during the processing of the activity or request. Use themessageattribute of the base class for details.99-Other: The disposition is not listed. Thedispositionattribute should be populated with a source specific caption.
Describes the outcome or action taken by a security control, such as access control checks, malware detections or various types of policy violations.
evidences
- Type:
evidences - Requirement: recommended
Describes various evidence artifacts associated to the activity/activities that triggered a security detection.
message
- Type:
string_t - Requirement: recommended
The description of the event/finding, as defined by the source.
action security_control
- Type:
string_t - Requirement: optional
The normalized caption of action_id.
actor host
- Type:
actor - Requirement: optional
The actor object describes details about the user/role/process that was the source of the activity.
attacks security_control
- Type:
attack - Requirement: optional
An array of MITRE ATT&CK® objects describing the tactics, techniques & sub-techniques identified by a security control or finding.
authorizations security_control
- Type:
authorization - Requirement: optional
Provides details about an authorization, such as authorization outcome, and any associated policies related to the activity/event.
device host
- Type:
device - Requirement: optional
Describes the affected device/host. It can be used in conjunction with Affected Resource(s).
e.g. Specific details about an AWS EC2 instance, that is affected by the Finding.
disposition security_control
- Type:
string_t - Requirement: optional
The disposition name, normalized to the caption of the disposition_id value. In the case of ‘Other’, it is defined by the event source.
firewall_rule security_control
- Type:
firewall_rule - Requirement: optional
The firewall rule that triggered the event.
malware security_control
- Type:
malware - Requirement: optional
A list of Malware objects, describing details about the identified malware.
observables
- Type:
observable - Requirement: optional
The observables associated with the event or a finding.
status_code
- Type:
string_t - Requirement: optional
The event status code, as reported by the event source.
For example, in a Windows Failed Authentication event, this would be the value of ‘Failure Code’, e.g. 0x18.
status_detail
- Type:
string_t - Requirement: optional
The status details contains additional information about the event/finding outcome.