- JSON representation
- SecurityCategory
- AlertState
- FindingVariable
- Type
- BoolSequence
- BytesSequence
- DoubleSequence
- Int64Sequence
- Uint64Sequence
- StringSequence
- Action
- ProductSeverity
- ProductConfidence
- ProductPriority
- AnalyticsMetadata
- ThreatStatus
- AttackDetails
- Tactic
- Technique
- Association
- AssociationType
- AssociationAlias
- Verdict
- ProviderMLVerdict
- Source
- AnalystVerdict
- VerdictResponse
- VerdictInfo
- VerdictType
- IoCStats
- IoCStatsType
- ThreatVerdict
Security related metadata for the event. A security result might be something like "virus detected and quarantined," "malicious connection blocked," or "sensitive data included in document foo.doc." Each security result, of which there may be more than one, may either pertain to the whole event, or to a specific object or device referenced in the event (e.g. a malicious file that was detected, or a sensitive document sent as an email attachment). For security results that apply to a particular object referenced in the event, the security_results message MUST contain details about the implicated object (such as process, user, IP, domain, URL, IP, or email address) in the about field. For security results that apply to the entire event (e.g. SPAM found in this email), the about field must remain empty.
JSON representation |
---|
{ "about": { object ( |
Fields | |
---|---|
about |
If the security result is about a specific entity (Noun), add it here. This field is not populated when the SecurityResult appears in a finding (a detection or alert). |
category[] |
The security category. This field is not populated when the SecurityResult appears in a finding (a detection or alert). |
category_ |
For vendor-specific categories. For web categorization, put type in here such as "gambling" or "porn". This field is not populated when the SecurityResult appears in a finding (a detection or alert). |
threat_ |
A vendor-assigned classification common across multiple customers (for example, "W32/File-A", "Slammer"). This field is not populated when the SecurityResult appears in a finding (a detection or alert). |
rule_ |
The curated detection's rule set identifier. (for example, "windows-threats") This is primarily set in rule-generated detections and alerts. |
rule_ |
The curated detections rule set display name. This is primarily set in rule-generated detections and alerts. |
ruleset_ |
The curated detection rule set category display name. (for example, if rule_set_display_name is "CDIR SCC Enhanced Exfiltration", the rule_set_category is "Cloud Threats"). This is primarily set in rule-generated detections and alerts. |
rule_ |
A vendor-specific ID for a rule, varying by observer type (e.g. "08123", "5d2b44d0-5ef6-40f5-a704-47d61d3babbe"). |
rule_ |
Name of the security rule (e.g. "BlockInboundToOracle"). |
rule_ |
Version of the security rule. (e.g. "v1.1", "00001", "1604709794", "2020-11-16T23:04:19+00:00"). Note that rule versions are source-dependant and lexical ordering should not be assumed. |
rule_ |
The type of security rule. |
rule_ |
Author of the security rule. This field is not populated when the SecurityResult appears in a finding (a detection or alert). |
rule_ |
A list of rule labels that can't be captured by the other fields in security result (e.g. "reference : AnotherRule", "contributor : John"). This is primarily set in rule-generated detections and alerts. |
alert_ |
The alerting types of this security result. This is primarily set for rule-generated detections and alerts. |
detection_ |
An ordered list of values, that represent fields in detections for a security finding. This list represents mapping of names of requested entities to their values (the security result matched variables). This is only populated when the SecurityResult appears in a finding (a detection or alert). |
outcomes[] |
A list of outcomes that represent the results of this security finding. This list represents a mapping of names of the requested outcomes, to a stringified version of their values. This is only populated when the SecurityResult appears in a finding (a detection or alert). |
variables |
A list of outcomes and match variables that represent the results of this security finding. This list represents a mapping of names of the requested outcomes or match variables, to their values. This is only populated when the SecurityResult appears in a finding (a detection or alert). An object containing a list of |
summary |
A short human-readable summary (e.g. "failed login occurred") |
description |
A human-readable description (e.g. "user password was wrong"). This can be more detailed than the summary. |
action[] |
Actions taken for this event. This field is not populated when the SecurityResult appears in a finding (a detection or alert). |
action_ |
The detail of the action taken as provided by the vendor. This field is not populated when the SecurityResult appears in a finding (a detection or alert). |
severity |
The severity of the result. |
confidence |
The confidence level of the result as estimated by the product. This field is not populated when the SecurityResult appears in a finding (a detection or alert). |
priority |
The priority of the result. This field is not populated when the SecurityResult appears in a finding (a detection or alert). |
risk_ |
The risk score of the security result. |
confidence_ |
The confidence score of the security result. This field is not populated when the SecurityResult appears in a finding (a detection or alert). |
analytics_ |
Stores metadata about each risk analytic metric the rule uses. This field is not populated when the SecurityResult appears in a finding (a detection or alert). |
severity_ |
Vendor-specific severity. This field is not populated when the SecurityResult appears in a finding (a detection or alert). |
confidence_ |
Additional detail with regards to the confidence of a security event as estimated by the product vendor. This field is not populated when the SecurityResult appears in a finding (a detection or alert). |
priority_ |
Vendor-specific information about the security result priority. This field is not populated when the SecurityResult appears in a finding (a detection or alert). |
url_ |
URL that takes the user to the source product console for this event. This field is not populated when the SecurityResult appears in a finding (a detection or alert). |
threat_ |
Vendor-specific ID for a threat. This field is not populated when the SecurityResult appears in a finding (a detection or alert). |
threat_ |
Vendor feed name for a threat indicator feed. This field is not populated when the SecurityResult appears in a finding (a detection or alert). |
threat_ |
The attribute threat_id_namespace qualifies threat_id with an id namespace to get an unique id. The attribute threat_id by itself is not unique across Chronicle as it is a vendor specific id. This field is not populated when the SecurityResult appears in a finding (a detection or alert). |
threat_ |
Current status of the threat This field is not populated when the SecurityResult appears in a finding (a detection or alert). |
attack_ |
MITRE ATT&CK details. This field is not populated when the SecurityResult appears in a finding (a detection or alert). |
first_ |
First time the IoC threat was discovered in the provider. This field is not populated when the SecurityResult appears in a finding (a detection or alert). Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted.Examples: |
associations[] |
Associations related to the threat. This field is not populated when the SecurityResult appears in a finding (a detection or alert). |
campaigns[] |
Campaigns using this IOC threat. This field is not populated when the SecurityResult appears in a finding (a detection or alert). |
reports[] |
Reports that reference this IOC threat. These are the report IDs. This field is not populated when the SecurityResult appears in a finding (a detection or alert). |
verdict |
Verdict about the IoC from the provider. This field is now deprecated. Use VerdictInfo instead. |
last_ |
Last time the IoC threat was updated in the provider. This field is not populated when the SecurityResult appears in a finding (a detection or alert). Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted.Examples: |
verdict_ |
Verdict information about the IoC from the provider. This field is not populated when the SecurityResult appears in a finding (a detection or alert). |
threat_ |
GCTI threat verdict on the security result entity. This field is not populated when the SecurityResult appears in a finding (a detection or alert). |
last_ |
Last time the IoC was seen in the provider data. This field is not populated when the SecurityResult appears in a finding (a detection or alert). Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted.Examples: |
SecurityCategory
SecurityCategory is used to standardize security categories across products so one event is not categorized as "malware" and another as a "virus".
Enums | |
---|---|
UNKNOWN_CATEGORY |
The default category. |
SOFTWARE_MALICIOUS |
Malware, spyware, rootkit. |
SOFTWARE_SUSPICIOUS |
Below the conviction threshold; probably bad. |
SOFTWARE_PUA |
Potentially Unwanted App (such as adware). |
NETWORK_MALICIOUS |
Includes C&C or network exploit. |
NETWORK_SUSPICIOUS |
Suspicious activity, such as potential reverse tunnel. |
NETWORK_CATEGORIZED_CONTENT |
Non-security related: URL has category like gambling or porn. |
NETWORK_DENIAL_OF_SERVICE |
DoS, DDoS. |
NETWORK_RECON |
Port scan detected by an IDS, probing of web app. |
NETWORK_COMMAND_AND_CONTROL |
If we know this is a C&C channel. |
ACL_VIOLATION |
Unauthorized access attempted, including attempted access to files, web services, processes, web objects, etc. |
AUTH_VIOLATION |
Authentication failed (e.g. bad password or bad 2-factor authentication). |
EXPLOIT |
Exploit: For all manner of exploits including attempted overflows, bad protocol encodings, ROP, SQL injection, etc. For both network and host- based exploits. |
DATA_EXFILTRATION |
DLP: Sensitive data transmission, copy to thumb drive. |
DATA_AT_REST |
DLP: Sensitive data found at rest in a scan. |
DATA_DESTRUCTION |
Attempt to destroy/delete data. |
TOR_EXIT_NODE |
TOR Exit Nodes. |
MAIL_SPAM |
@exclude Spam email, message, etc. |
MAIL_PHISHING |
Phishing email, chat messages, etc. |
MAIL_SPOOFING |
Spoofed source email address, etc. |
POLICY_VIOLATION |
Security-related policy violation (e.g. firewall/proxy/HIPS rule violated, NAC block action). |
SOCIAL_ENGINEERING |
Threats which manipulate to break normal security procedures. |
PHISHING |
Phishing pages, pops, https phishing etc. |
AlertState
The type of alerting set up for a security result.
Enums | |
---|---|
UNSPECIFIED |
The security result type is not known. |
NOT_ALERTING |
The security result is not an alert. |
ALERTING |
The security result is an alert. |
FindingVariable
A structure that holds the value and associated metadata for values extracted while producing a Finding.
JSON representation |
---|
{ "type": enum ( |
Fields | |
---|---|
type |
The type of the variable. |
value |
The value in string form. |
source_ |
The UDM field path for the field which this value was derived from. Example: |
Union field typed_value . The typed value of the variable. typed_value can be only one of the following: |
|
bool_ |
The value in boolean format. |
bytes_ |
The value in bytes format. A base64-encoded string. |
double_ |
The value in double format. |
int64_ |
The value in int64 format. |
uint64_ |
The value in uint64 format. |
string_ |
The value in string format. Enum values are returned as strings. |
null_ |
Whether the value is null. |
bool_ |
The value in boolsequence format. |
bytes_ |
The value in bytessequence format. |
double_ |
The value in doublesequence format. |
int64_ |
The value in int64sequence format. |
uint64_ |
The value in uint64sequence format. |
string_ |
The value in stringsequence format. |
Type
Type options for Finding variables.
Enums | |
---|---|
TYPE_UNSPECIFIED |
An unspecified variable type. |
MATCH |
A variable coming from the match conditions. |
OUTCOME |
A variable representing significant data that was found in the detection logic. |
BoolSequence
BoolSequence represents a sequence of bools.
JSON representation |
---|
{ "bool_vals": [ boolean ] } |
Fields | |
---|---|
bool_ |
bool sequence. |
BytesSequence
BytesSequence represents a sequence of bytes.
JSON representation |
---|
{ "bytes_vals": [ string ] } |
Fields | |
---|---|
bytes_ |
bytes sequence. A base64-encoded string. |
DoubleSequence
DoubleSequence represents a sequence of doubles.
JSON representation |
---|
{ "double_vals": [ number ] } |
Fields | |
---|---|
double_ |
double sequence. |
Int64Sequence
Int64Sequence represents a sequence of int64s.
JSON representation |
---|
{ "int64_vals": [ string ] } |
Fields | |
---|---|
int64_ |
int64 sequence. |
Uint64Sequence
Uint64Sequence represents a sequence of uint64s.
JSON representation |
---|
{ "uint64_vals": [ string ] } |
Fields | |
---|---|
uint64_ |
uint64 sequence. |
StringSequence
StringSequence represents a sequence of string.
JSON representation |
---|
{ "string_vals": [ string ] } |
Fields | |
---|---|
string_ |
string sequence. |
Action
Enum representing different possible actions taken by the product that created the event.
Enums | |
---|---|
UNKNOWN_ACTION |
The default action. |
ALLOW |
Allowed. |
BLOCK |
Blocked. |
ALLOW_WITH_MODIFICATION |
Strip, modify something (e.g. File or email was disinfected or rewritten and still forwarded). |
QUARANTINE |
Put somewhere for later analysis (does NOT imply block). |
FAIL |
Failed (e.g. the event was allowed but failed). |
CHALLENGE |
Challenged (e.g. the user was challenged by a Captcha, 2FA). |
ProductSeverity
Defined by the product
Enums | |
---|---|
UNKNOWN_SEVERITY |
The default severity level. |
INFORMATIONAL |
Info severity. |
ERROR |
An error. |
NONE |
No malicious result. |
LOW |
Low-severity malicious result. |
MEDIUM |
Medium-severity malicious result. |
HIGH |
High-severity malicious result. |
CRITICAL |
Critical-severity malicious result. |
ProductConfidence
A level of confidence in the result.
Enums | |
---|---|
UNKNOWN_CONFIDENCE |
The default confidence level. |
LOW_CONFIDENCE |
Low confidence. |
MEDIUM_CONFIDENCE |
Medium confidence. |
HIGH_CONFIDENCE |
High confidence. |
ProductPriority
A product priority level.
Enums | |
---|---|
UNKNOWN_PRIORITY |
Default priority level. |
LOW_PRIORITY |
Low priority. |
MEDIUM_PRIORITY |
Medium priority. |
HIGH_PRIORITY |
High priority. |
AnalyticsMetadata
Stores information about an analytics metric used in a rule.
JSON representation |
---|
{ "analytic": string } |
Fields | |
---|---|
analytic |
Name of the analytic. |
ThreatStatus
Vendor-specific information about the status of a threat (ITW).
Enums | |
---|---|
THREAT_STATUS_UNSPECIFIED |
Default threat status |
ACTIVE |
Active threat. |
CLEARED |
Cleared threat. |
FALSE_POSITIVE |
False positive. |
AttackDetails
MITRE ATT&CK details.
JSON representation |
---|
{ "version": string, "tactics": [ { object ( |
Fields | |
---|---|
version |
ATT&CK version (e.g. 12.1). |
tactics[] |
Tactics employed. |
techniques[] |
Techniques employed. |
Tactic
Tactic information related to an attack or threat.
JSON representation |
---|
{ "id": string, "name": string } |
Fields | |
---|---|
id |
Tactic ID (e.g. "TA0043"). |
name |
Tactic Name (e.g. "Reconnaissance") |
Technique
Technique information related to an attack or threat.
JSON representation |
---|
{ "id": string, "name": string, "subtechnique_id": string, "subtechnique_name": string } |
Fields | |
---|---|
id |
Technique ID (e.g. "T1595"). |
name |
Technique Name (e.g. "Active Scanning"). |
subtechnique_ |
Subtechnique ID (e.g. "T1595.001"). |
subtechnique_ |
Subtechnique Name (e.g. "Scanning IP Blocks"). |
Association
Associations represents different metadata about malware and threat actors involved with an IoC.
JSON representation |
---|
{ "id": string, "country_code": [ string ], "type": enum ( |
Fields | |
---|---|
id |
Unique association id generated by mandiant. |
country_ |
Country from which the threat actor/ malware is originated. |
type |
Signifies the type of association. |
name |
Name of the threat actor/malware. |
description |
Human readable description about the association. |
role |
Role of the malware. Not applicable for threat actor. |
source_country |
Name of the country the threat originated from. |
alias[] |
Different aliases of the threat actor given by different sources. |
first_ |
First time the threat actor was referenced or seen. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted.Examples: |
last_ |
Last time the threat actor was referenced or seen. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted.Examples: |
industries_ |
List of industries the threat actor affects. |
associated_ |
List of associated threat actors for a malware. Not applicable for threat actors. |
region_ |
Name of the country, the threat is originating from. |
sponsor_ |
Sponsor region of the threat actor. |
targeted_ |
Targeted regions. |
tags[] |
Tags. |
AssociationType
Represents different possible Association types. Can be threat or malware. Used to represent Mandiant threat intelligence.
Enums | |
---|---|
ASSOCIATION_TYPE_UNSPECIFIED |
The default Association Type. |
THREAT_ACTOR |
Association type Threat actor. |
MALWARE |
Association type Malware. |
AssociationAlias
Association Alias used to represent Mandiant Threat Intelligence.
JSON representation |
---|
{ "name": string, "company": string } |
Fields | |
---|---|
name |
Name of the alias. |
company |
Name of the provider who gave the association's name. |
Verdict
Deprecated. Encapsulates the threat verdict provided by human analysts and ML models. These fields are used to model Mandiant sources.
JSON representation |
---|
{ "source_count": integer, "response_count": integer, "neighbour_influence": string, "verdict": { object ( |
Fields | |
---|---|
source_ |
Number of sources from which intelligence was extracted. |
response_ |
Total response count across all sources. |
neighbour_ |
Describes the neighbour influence of the verdict. |
verdict |
ML Verdict provided by sources like Mandiant. |
analyst_ |
Human analyst verdict provided by sources like Mandiant. |
ProviderMLVerdict
Deprecated. MLVerdict result provided from threat providers, like Mandiant. These fields are used to model Mandiant sources.
JSON representation |
---|
{ "source_provider": string, "benign_count": integer, "malicious_count": integer, "confidence_score": integer, "mandiant_sources": [ { object ( |
Fields | |
---|---|
source_ |
Source provider giving the ML verdict. |
benign_ |
Count of responses where this IoC was marked benign. |
malicious_ |
Count of responses where this IoC was marked malicious. |
confidence_ |
Confidence score of the verdict. |
mandiant_ |
List of mandiant sources from which the verdict was generated. |
third_ |
List of third-party sources from which the verdict was generated. |
Source
Deprecated. Information about the threat intelligence source. These fields are used to model Mandiant sources.
JSON representation |
---|
{ "name": string, "benign_count": integer, "malicious_count": integer, "quality": enum ( |
Fields | |
---|---|
name |
Name of the IoC source. |
benign_ |
Count of responses where this IoC was marked benign. |
malicious_ |
Count of responses where this IoC was marked malicious. |
quality |
Quality of the IoC mapping extracted from the source. |
response_ |
Total response count from this source. |
source_ |
Number of sources from which intelligence was extracted. |
threat_ |
Different threat intelligence sources from which IoC info was extracted. |
AnalystVerdict
Verdict provided by the human analyst. These fields are used to model Mandiant sources.
JSON representation |
---|
{
"confidence_score": integer,
"verdict_time": string,
"verdict_response": enum ( |
Fields | |
---|---|
confidence_ |
Confidence score of the verdict. |
verdict_ |
Timestamp at which the verdict was generated. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted.Examples: |
verdict_ |
Details of the verdict. |
VerdictResponse
Represents different verdict types. Used to represent Mandiant threat intelligence.
Enums | |
---|---|
VERDICT_RESPONSE_UNSPECIFIED |
The default verdict response type. |
MALICIOUS |
VerdictResponse resulted a threat as malicious. |
BENIGN |
VerdictResponse resulted a threat as benign. |
VerdictInfo
Describes the threat verdict provided by human analysts and machine learning models. These fields are used to model Mandiant sources.
JSON representation |
---|
{ "source_count": integer, "response_count": integer, "neighbour_influence": string, "verdict_type": enum ( |
Fields | |
---|---|
source_ |
Number of sources from which intelligence was extracted. |
response_ |
Total response count across all sources. |
neighbour_ |
Describes the near neighbor influence of the verdict. |
verdict_ |
Type of verdict. |
source_ |
Source provider giving the machine learning verdict. |
benign_ |
Count of responses where this IoC was marked as benign. |
malicious_ |
Count of responses where this IoC was marked as malicious. |
confidence_ |
Confidence score of the verdict. |
ioc_ |
List of IoCStats from which the verdict was generated. |
verdict_ |
Timestamp when the verdict was generated. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted.Examples: |
verdict_ |
Details about the verdict. |
global_ |
Global customer count over the last 30 days |
global_ |
Global hit count over the last 30 days. |
pwn |
Whether one or more Mandiant incident response customers had this indicator in their environment. |
category_ |
Tags related to the verdict. |
pwn_ |
The timestamp of the first time a pwn was associated to this entity. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted.Examples: |
VerdictType
Category of the verdict.
Enums | |
---|---|
VERDICT_TYPE_UNSPECIFIED |
Verdict category not specified. |
PROVIDER_ML_VERDICT |
MLVerdict result provided from threat providers, like Mandiant. These fields are used to model Mandiant sources. |
ANALYST_VERDICT |
Verdict provided by the human analyst. These fields are used to model Mandiant sources. |
IoCStats
Information about the threat intelligence source. These fields are used to model Mandiant sources.
JSON representation |
---|
{ "ioc_stats_type": enum ( |
Fields | |
---|---|
ioc_ |
Describes the source of the IoCStat. |
first_ |
Name of first level IoC source, for example Mandiant or a third-party. |
second_ |
Name of the second-level IoC source, for example Crowdsourced Threat Analysis or Knowledge Graph. |
benign_ |
Count of responses where the IoC was identified as benign. |
quality |
Level of confidence in the IoC mapping extracted from the source. |
malicious_ |
Count of responses where the IoC was identified as malicious. |
response_ |
Total number of response from the source. |
source_ |
Number of sources from which information was extracted. |
IoCStatsType
Type of IoCStat based on source.
Enums | |
---|---|
UNSPECIFIED_IOC_STATS_TYPE |
IoCStat source is unidentified. |
MANDIANT_SOURCES |
IoCStat is from a Mandiant Source. |
THIRD_PARTY_SOURCES |
IoCStat is from a third-party source. |
THREAT_INTELLIGENCE_IOC_STATS |
IoCStat is from a threat intelligence feed. |
ThreatVerdict
GCTI threat verdict levels.
Enums | |
---|---|
THREAT_VERDICT_UNSPECIFIED |
Unspecified threat verdict level. |
UNDETECTED |
Undetected threat verdict level. |
SUSPICIOUS |
Suspicious threat verdict level. |
MALICIOUS |
Malicious threat verdict level. |