Class: Google::Apis::SecuritycenterV1beta2::Finding

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/securitycenter_v1beta2/classes.rb,
lib/google/apis/securitycenter_v1beta2/representations.rb,
lib/google/apis/securitycenter_v1beta2/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Finding

Returns a new instance of Finding.



821
822
823
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 821

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#access ⇒ Google::Apis::SecuritycenterV1beta2::Access

Represents an access event. Corresponds to the JSON property access

Returns:



633
634
635
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 633

def access
  @access
end

#canonical_name ⇒ String

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. Corresponds to the JSON property canonicalName

Returns:

  • (String) 


642
643
644
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 642

def canonical_name
  @canonical_name
end

#category ⇒ String

The additional taxonomy group within findings from a given source. This field is immutable after creation time. Example: "XSS_FLASH_INJECTION" Corresponds to the JSON property category

Returns:

  • (String) 


648
649
650
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 648

def category
  @category
end

#compliances ⇒ Array<Google::Apis::SecuritycenterV1beta2::Compliance>

Contains compliance information for security standards associated to the finding. Corresponds to the JSON property compliances

Returns:



654
655
656
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 654

def compliances
  @compliances
end

#connections ⇒ Array<Google::Apis::SecuritycenterV1beta2::Connection>

Contains information about the IP connection associated with the finding. Corresponds to the JSON property connections

Returns:



659
660
661
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 659

def connections
  @connections
end

#contacts ⇒ Hash<String,Google::Apis::SecuritycenterV1beta2::ContactDetails>

Output only. Map containing the point of contacts 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":[ "contact":"email":"person1@company.com" , "contact":" email":“person2@company.com” ] Corresponds to the JSON property contacts

Returns:



669
670
671
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 669

def contacts
  @contacts
end

#create_time ⇒ String

The time at which the finding was created in Security Command Center. Corresponds to the JSON property createTime

Returns:

  • (String) 


674
675
676
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 674

def create_time
  @create_time
end

#description ⇒ String

Contains more detail about the finding. Corresponds to the JSON property description

Returns:

  • (String) 


679
680
681
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 679

def description
  @description
end

#event_time ⇒ String

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. Corresponds to the JSON property eventTime

Returns:

  • (String) 


689
690
691
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 689

def event_time
  @event_time
end

#exfiltration ⇒ Google::Apis::SecuritycenterV1beta2::Exfiltration

Exfiltration represents a data exfiltration attempt of one or more sources to one or more targets. Sources represent the source of data that is exfiltrated, and Targets represents the destination the data was copied to. Corresponds to the JSON property exfiltration

Returns:



696
697
698
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 696

def exfiltration
  @exfiltration
end

#external_systems ⇒ Hash<String,Google::Apis::SecuritycenterV1beta2::GoogleCloudSecuritycenterV1ExternalSystem>

Output only. Third party SIEM/SOAR fields within SCC, contains external system information and external system finding fields. Corresponds to the JSON property externalSystems

Returns:



702
703
704
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 702

def external_systems
  @external_systems
end

#external_uri ⇒ String

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. Corresponds to the JSON property externalUri

Returns:

  • (String) 


709
710
711
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 709

def external_uri
  @external_uri
end

#finding_class ⇒ String

The class of the finding. Corresponds to the JSON property findingClass

Returns:

  • (String) 


714
715
716
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 714

def finding_class
  @finding_class
end

#iam_bindings ⇒ Array<Google::Apis::SecuritycenterV1beta2::IamBinding>

Represents IAM bindings associated with the Finding. Corresponds to the JSON property iamBindings

Returns:



719
720
721
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 719

def iam_bindings
  @iam_bindings
end

#indicator ⇒ Google::Apis::SecuritycenterV1beta2::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. Reference: https://en.wikipedia.org/wiki/Indicator_of_compromise Corresponds to the JSON property indicator

Returns:



727
728
729
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 727

def indicator
  @indicator
end

#mitre_attack ⇒ Google::Apis::SecuritycenterV1beta2::MitreAttack

MITRE ATT&CK tactics and techniques related to this finding. See: https:// attack.mitre.org Corresponds to the JSON property mitreAttack

Returns:



733
734
735
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 733

def mitre_attack
  @mitre_attack
end

#mute ⇒ String

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. Corresponds to the JSON property mute

Returns:

  • (String) 


740
741
742
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 740

def mute
  @mute
end

#mute_initiator ⇒ String

First known as mute_annotation. Records additional information about the mute operation e.g. mute config that muted the finding, user who muted the finding, etc. Unlike other attributes of a finding, a finding provider shouldn't set the value of mute. Corresponds to the JSON property muteInitiator

Returns:

  • (String) 


748
749
750
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 748

def mute_initiator
  @mute_initiator
end

#mute_update_time ⇒ String

Output only. The most recent time this finding was muted or unmuted. Corresponds to the JSON property muteUpdateTime

Returns:

  • (String) 


753
754
755
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 753

def mute_update_time
  @mute_update_time
end

#name ⇒ String

The relative resource name of this finding. See: https://cloud.google.com/apis/ design/resource_names#relative_resource_name Example: "organizations/ organization_id/sources/source_id/findings/finding_id" Corresponds to the JSON property name

Returns:

  • (String) 


760
761
762
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 760

def name
  @name
end

#next_steps ⇒ String

Next steps associate to the finding. Corresponds to the JSON property nextSteps

Returns:

  • (String) 


765
766
767
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 765

def next_steps
  @next_steps
end

#parent ⇒ String

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" Corresponds to the JSON property parent

Returns:

  • (String) 


773
774
775
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 773

def parent
  @parent
end

#processes ⇒ Array<Google::Apis::SecuritycenterV1beta2::Process>

Represents operating system processes associated with the Finding. Corresponds to the JSON property processes

Returns:



778
779
780
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 778

def processes
  @processes
end

#resource_name ⇒ String

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. Corresponds to the JSON property resourceName

Returns:

  • (String) 


787
788
789
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 787

def resource_name
  @resource_name
end

#security_marks ⇒ Google::Apis::SecuritycenterV1beta2::SecurityMarks

User specified security marks that are attached to the parent Security Command Center resource. Security marks are scoped within a Security Command Center organization -- they can be modified and viewed by all users who have proper permissions on the organization. Corresponds to the JSON property securityMarks

Returns:



795
796
797
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 795

def security_marks
  @security_marks
end

#severity ⇒ String

The severity of the finding. This field is managed by the source that writes the finding. Corresponds to the JSON property severity

Returns:

  • (String) 


801
802
803
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 801

def severity
  @severity
end

#source_properties ⇒ Hash<String,Object>

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. Corresponds to the JSON property sourceProperties

Returns:

  • (Hash<String,Object>) 


809
810
811
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 809

def source_properties
  @source_properties
end

#state ⇒ String

The state of the finding. Corresponds to the JSON property state

Returns:

  • (String) 


814
815
816
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 814

def state
  @state
end

#vulnerability ⇒ Google::Apis::SecuritycenterV1beta2::Vulnerability

Refers to common vulnerability fields e.g. cve, cvss, cwe etc. Corresponds to the JSON property vulnerability

Returns:



819
820
821
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 819

def vulnerability
  @vulnerability
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
 
# File 'lib/google/apis/securitycenter_v1beta2/classes.rb', line 826

def update!(**args)
  @access = args[:access] if args.key?(:access)
  @canonical_name = args[:canonical_name] if args.key?(:canonical_name)
  @category = args[:category] if args.key?(:category)
  @compliances = args[:compliances] if args.key?(:compliances)
  @connections = args[:connections] if args.key?(:connections)
  @contacts = args[:contacts] if args.key?(:contacts)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @event_time = args[:event_time] if args.key?(:event_time)
  @exfiltration = args[:exfiltration] if args.key?(:exfiltration)
  @external_systems = args[:external_systems] if args.key?(:external_systems)
  @external_uri = args[:external_uri] if args.key?(:external_uri)
  @finding_class = args[:finding_class] if args.key?(:finding_class)
  @iam_bindings = args[:iam_bindings] if args.key?(:iam_bindings)
  @indicator = args[:indicator] if args.key?(:indicator)
  @mitre_attack = args[:mitre_attack] if args.key?(:mitre_attack)
  @mute = args[:mute] if args.key?(:mute)
  @mute_initiator = args[:mute_initiator] if args.key?(:mute_initiator)
  @mute_update_time = args[:mute_update_time] if args.key?(:mute_update_time)
  @name = args[:name] if args.key?(:name)
  @next_steps = args[:next_steps] if args.key?(:next_steps)
  @parent = args[:parent] if args.key?(:parent)
  @processes = args[:processes] if args.key?(:processes)
  @resource_name = args[:resource_name] if args.key?(:resource_name)
  @security_marks = args[:security_marks] if args.key?(:security_marks)
  @severity = args[:severity] if args.key?(:severity)
  @source_properties = args[:source_properties] if args.key?(:source_properties)
  @state = args[:state] if args.key?(:state)
  @vulnerability = args[:vulnerability] if args.key?(:vulnerability)
end