Finding(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Security Command Center finding. A finding is a record of assessment data like security, risk, health, or privacy, that is ingested into Security Command Center for presentation, notification, analysis, policy testing, and enforcement. For example, a cross-site scripting (XSS) vulnerability in an App Engine application is a finding.
Attributes | |
---|---|
Name | Description |
name |
str
The `relative resource name |
parent |
str
The relative resource name of the source the finding belongs to. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name This field is immutable after creation time. For example: "organizations/{organization_id}/sources/{source_id}". |
resource_name |
str
For findings on Google Cloud resources, the full resource name of the Google Cloud resource this finding is for. See: https://cloud.google.com/apis/design/resource_names#full_resource_name When the finding is for a non-Google Cloud resource, the resourceName can be a customer or partner defined string. This field is immutable after creation time. |
state |
google.cloud.securitycenter_v1.types.Finding.State
The state of the finding. |
category |
str
The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION". |
external_uri |
str
The URI that, if available, points to a web page outside of Security Command Center where additional information about the finding can be found. This field is guaranteed to be either empty or a well formed URL. |
source_properties |
MutableMapping[str, google.protobuf.struct_pb2.Value]
Source specific properties. These properties are managed by the source that writes the finding. The key names in the source_properties map must be between 1 and 255 characters, and must start with a letter and contain alphanumeric characters or underscores only. |
security_marks |
google.cloud.securitycenter_v1.types.SecurityMarks
Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding. |
event_time |
google.protobuf.timestamp_pb2.Timestamp
The time the finding was first detected. If an existing finding is updated, then this is the time the update occurred. For example, if the finding represents an open firewall, this property captures the time the detector believes the firewall became open. The accuracy is determined by the detector. If the finding is later resolved, then this time reflects when the finding was resolved. This must not be set to a value greater than the current timestamp. |
create_time |
google.protobuf.timestamp_pb2.Timestamp
The time at which the finding was created in Security Command Center. |
severity |
google.cloud.securitycenter_v1.types.Finding.Severity
The severity of the finding. This field is managed by the source that writes the finding. |
canonical_name |
str
The canonical name of the finding. It's either "organizations/{organization_id}/sources/{source_id}/findings/{finding_id}", "folders/{folder_id}/sources/{source_id}/findings/{finding_id}" or "projects/{project_number}/sources/{source_id}/findings/{finding_id}", depending on the closest CRM ancestor of the resource associated with the finding. |
mute |
google.cloud.securitycenter_v1.types.Finding.Mute
Indicates the mute state of a finding (either muted, unmuted or undefined). Unlike other attributes of a finding, a finding provider shouldn't set the value of mute. |
finding_class |
google.cloud.securitycenter_v1.types.Finding.FindingClass
The class of the finding. |
indicator |
google.cloud.securitycenter_v1.types.Indicator
Represents what's commonly known as an *indicator of compromise* (IoC) in computer forensics. This is an artifact observed on a network or in an operating system that, with high confidence, indicates a computer intrusion. For more information, see `Indicator of compromise |
vulnerability |
google.cloud.securitycenter_v1.types.Vulnerability
Represents vulnerability-specific fields like CVE and CVSS scores. CVE stands for Common Vulnerabilities and Exposures (https://cve.mitre.org/about/) |
mute_update_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The most recent time this finding was muted or unmuted. |
external_systems |
MutableMapping[str, google.cloud.securitycenter_v1.types.ExternalSystem]
Output only. Third party SIEM/SOAR fields within SCC, contains external system information and external system finding fields. |
mitre_attack |
google.cloud.securitycenter_v1.types.MitreAttack
MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org |
access |
google.cloud.securitycenter_v1.types.Access
Access details associated with the finding, such as more information on the caller, which method was accessed, and from where. |
connections |
MutableSequence[google.cloud.securitycenter_v1.types.Connection]
Contains information about the IP connection associated with the finding. |
mute_initiator |
str
Records additional information about the mute operation, for example, the `mute configuration `__ that muted the finding and the user who muted the finding. |
processes |
MutableSequence[google.cloud.securitycenter_v1.types.Process]
Represents operating system processes associated with the Finding. |
contacts |
MutableMapping[str, google.cloud.securitycenter_v1.types.ContactDetails]
Output only. Map containing the points of contact for the given finding. The key represents the type of contact, while the value contains a list of all the contacts that pertain. Please refer to: https://cloud.google.com/resource-manager/docs/managing-notification-contacts#notification-categories :: { "security": { "contacts": [ { "email": "person1@company.com" }, { "email": "person2@company.com" } ] } } |
compliances |
MutableSequence[google.cloud.securitycenter_v1.types.Compliance]
Contains compliance information for security standards associated to the finding. |
parent_display_name |
str
Output only. The human readable display name of the finding source such as "Event Threat Detection" or "Security Health Analytics". |
description |
str
Contains more details about the finding. |
exfiltration |
google.cloud.securitycenter_v1.types.Exfiltration
Represents exfiltrations associated with the finding. |
iam_bindings |
MutableSequence[google.cloud.securitycenter_v1.types.IamBinding]
Represents IAM bindings associated with the finding. |
next_steps |
str
Steps to address the finding. |
module_name |
str
Unique identifier of the module which generated the finding. Example: folders/598186756061/securityHealthAnalyticsSettings/customModules/56799441161885 |
containers |
MutableSequence[google.cloud.securitycenter_v1.types.Container]
Containers associated with the finding. This field provides information for both Kubernetes and non-Kubernetes containers. |
kubernetes |
google.cloud.securitycenter_v1.types.Kubernetes
Kubernetes resources associated with the finding. |
database |
google.cloud.securitycenter_v1.types.Database
Database associated with the finding. |
files |
MutableSequence[google.cloud.securitycenter_v1.types.File]
File associated with the finding. |
cloud_dlp_inspection |
google.cloud.securitycenter_v1.types.CloudDlpInspection
Cloud Data Loss Prevention (Cloud DLP) inspection results that are associated with the finding. |
cloud_dlp_data_profile |
google.cloud.securitycenter_v1.types.CloudDlpDataProfile
Cloud DLP data profile that is associated with the finding. |
kernel_rootkit |
google.cloud.securitycenter_v1.types.KernelRootkit
Signature of the kernel rootkit. |
Classes
ContactsEntry
ContactsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
Parameters | |
---|---|
Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
A dictionary or message to be used to determine the values for this message. |
ignore_unknown_fields |
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if |
ExternalSystemsEntry
ExternalSystemsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
Parameters | |
---|---|
Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
A dictionary or message to be used to determine the values for this message. |
ignore_unknown_fields |
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if |
FindingClass
FindingClass(value)
Represents what kind of Finding it is.
Values: FINDING_CLASS_UNSPECIFIED (0): Unspecified finding class. THREAT (1): Describes unwanted or malicious activity. VULNERABILITY (2): Describes a potential weakness in software that increases risk to Confidentiality & Integrity & Availability. MISCONFIGURATION (3): Describes a potential weakness in cloud resource/asset configuration that increases risk. OBSERVATION (4): Describes a security observation that is for informational purposes. SCC_ERROR (5): Describes an error that prevents some SCC functionality.
Mute
Mute(value)
Mute state a finding can be in.
Values: MUTE_UNSPECIFIED (0): Unspecified. MUTED (1): Finding has been muted. UNMUTED (2): Finding has been unmuted. UNDEFINED (4): Finding has never been muted/unmuted.
Severity
Severity(value)
The severity of the finding.
Values: SEVERITY_UNSPECIFIED (0): This value is used for findings when a source doesn't write a severity value. CRITICAL (1): Vulnerability:
A critical vulnerability is easily discoverable
by an external actor, exploitable, and results
in the direct ability to execute arbitrary code,
exfiltrate data, and otherwise gain additional
access and privileges to cloud resources and
workloads. Examples include publicly accessible
unprotected user data and public SSH access with
weak or no passwords.
Threat:
Indicates a threat that is able to access,
modify, or delete data or execute unauthorized
code within existing resources.
HIGH (2):
Vulnerability:
A high risk vulnerability can be easily
discovered and exploited in combination with
other vulnerabilities in order to gain direct
access and the ability to execute arbitrary
code, exfiltrate data, and otherwise gain
additional access and privileges to cloud
resources and workloads. An example is a
database with weak or no passwords that is only
accessible internally. This database could
easily be compromised by an actor that had
access to the internal network.
Threat:
Indicates a threat that is able to create new
computational resources in an environment but
not able to access data or execute code in
existing resources.
MEDIUM (3):
Vulnerability:
A medium risk vulnerability could be used by an
actor to gain access to resources or privileges
that enable them to eventually (through multiple
steps or a complex exploit) gain access and the
ability to execute arbitrary code or exfiltrate
data. An example is a service account with
access to more projects than it should have. If
an actor gains access to the service account,
they could potentially use that access to
manipulate a project the service account was not
intended to.
Threat:
Indicates a threat that is able to cause
operational impact but may not access data or
execute unauthorized code.
LOW (4):
Vulnerability:
A low risk vulnerability hampers a security
organization's ability to detect vulnerabilities
or active threats in their deployment, or
prevents the root cause investigation of
security issues. An example is monitoring and
logs being disabled for resource configurations
and access.
Threat:
Indicates a threat that has obtained minimal
access to an environment but is not able to
access data, execute code, or create resources.
SourcePropertiesEntry
SourcePropertiesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)
The abstract base class for a message.
Parameters | |
---|---|
Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
A dictionary or message to be used to determine the values for this message. |
ignore_unknown_fields |
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if |
State
State(value)
The state of the finding.
Values: STATE_UNSPECIFIED (0): Unspecified state. ACTIVE (1): The finding requires attention and has not been addressed yet. INACTIVE (2): The finding has been fixed, triaged as a non-issue or otherwise addressed and is no longer active.