Class: Google::Apis::WebsecurityscannerV1::Finding

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

Overview

A Finding resource represents a vulnerability instance identified during a ScanRun.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Finding

Returns a new instance of Finding



238
239
240
 
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 238

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

Instance Attribute Details

#body ⇒ String

Output only. The body of the request that triggered the vulnerability. Corresponds to the JSON property body

Returns:

  • (String) 


144
145
146
 
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 144

def body
  @body
end

#description ⇒ String

Output only. The description of the vulnerability. Corresponds to the JSON property description

Returns:

  • (String) 


149
150
151
 
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 149

def description
  @description
end

#final_url ⇒ String

Output only. The URL where the browser lands when the vulnerability is detected. Corresponds to the JSON property finalUrl

Returns:

  • (String) 


155
156
157
 
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 155

def final_url
  @final_url
end

#finding_type ⇒ String

Output only. The type of the Finding. Detailed and up-to-date information on findings can be found here: https://cloud.google.com/security-scanner/docs/scan-result-details Corresponds to the JSON property findingType

Returns:

  • (String) 


162
163
164
 
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 162

def finding_type
  @finding_type
end

#form ⇒ Google::Apis::WebsecurityscannerV1::Form

! Information about a vulnerability with an HTML. Corresponds to the JSON property form

Returns:



167
168
169
 
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 167

def form
  @form
end

#frame_url ⇒ String

Output only. If the vulnerability was originated from nested IFrame, the immediate parent IFrame is reported. Corresponds to the JSON property frameUrl

Returns:

  • (String) 


174
175
176
 
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 174

def frame_url
  @frame_url
end

#fuzzed_url ⇒ String

Output only. The URL produced by the server-side fuzzer and used in the request that triggered the vulnerability. Corresponds to the JSON property fuzzedUrl

Returns:

  • (String) 


181
182
183
 
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 181

def fuzzed_url
  @fuzzed_url
end

#http_method ⇒ String

Output only. The http method of the request that triggered the vulnerability, in uppercase. Corresponds to the JSON property httpMethod

Returns:

  • (String) 


188
189
190
 
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 188

def http_method
  @http_method
end

#name ⇒ String

Output only. The resource name of the Finding. The name follows the format of 'projects/projectId/scanConfigs/scanConfigId/scanruns/scanRunId/findings/ findingId'. The finding IDs are generated by the system. Corresponds to the JSON property name

Returns:

  • (String) 


196
197
198
 
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 196

def name
  @name
end

#outdated_library ⇒ Google::Apis::WebsecurityscannerV1::OutdatedLibrary

Information reported for an outdated library. Corresponds to the JSON property outdatedLibrary

Returns:



201
202
203
 
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 201

def outdated_library
  @outdated_library
end

#reproduction_url ⇒ String

Output only. The URL containing human-readable payload that user can leverage to reproduce the vulnerability. Corresponds to the JSON property reproductionUrl

Returns:

  • (String) 


208
209
210
 
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 208

def reproduction_url
  @reproduction_url
end

#tracking_id ⇒ String

Output only. The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns. Corresponds to the JSON property trackingId

Returns:

  • (String) 


215
216
217
 
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 215

def tracking_id
  @tracking_id
end

#violating_resource ⇒ Google::Apis::WebsecurityscannerV1::ViolatingResource

Information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc. Corresponds to the JSON property violatingResource

Returns:



221
222
223
 
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 221

def violating_resource
  @violating_resource
end

#vulnerable_headers ⇒ Google::Apis::WebsecurityscannerV1::VulnerableHeaders

Information about vulnerable or missing HTTP Headers. Corresponds to the JSON property vulnerableHeaders

Returns:



226
227
228
 
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 226

def vulnerable_headers
  @vulnerable_headers
end

#vulnerable_parameters ⇒ Google::Apis::WebsecurityscannerV1::VulnerableParameters

Information about vulnerable request parameters. Corresponds to the JSON property vulnerableParameters

Returns:



231
232
233
 
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 231

def vulnerable_parameters
  @vulnerable_parameters
end

#xss ⇒ Google::Apis::WebsecurityscannerV1::Xss

Information reported for an XSS. Corresponds to the JSON property xss

Returns:



236
237
238
 
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 236

def xss
  @xss
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'generated/google/apis/websecurityscanner_v1/classes.rb', line 243

def update!(**args)
  @body = args[:body] if args.key?(:body)
  @description = args[:description] if args.key?(:description)
  @final_url = args[:final_url] if args.key?(:final_url)
  @finding_type = args[:finding_type] if args.key?(:finding_type)
  @form = args[:form] if args.key?(:form)
  @frame_url = args[:frame_url] if args.key?(:frame_url)
  @fuzzed_url = args[:fuzzed_url] if args.key?(:fuzzed_url)
  @http_method = args[:http_method] if args.key?(:http_method)
  @name = args[:name] if args.key?(:name)
  @outdated_library = args[:outdated_library] if args.key?(:outdated_library)
  @reproduction_url = args[:reproduction_url] if args.key?(:reproduction_url)
  @tracking_id = args[:tracking_id] if args.key?(:tracking_id)
  @violating_resource = args[:violating_resource] if args.key?(:violating_resource)
  @vulnerable_headers = args[:vulnerable_headers] if args.key?(:vulnerable_headers)
  @vulnerable_parameters = args[:vulnerable_parameters] if args.key?(:vulnerable_parameters)
  @xss = args[:xss] if args.key?(:xss)
end