Google Cloud Web Security Scanner V1beta Client - Class Finding (0.7.18)

Reference documentation and code samples for the Google Cloud Web Security Scanner V1beta Client class Finding.

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

Generated from protobuf message google.cloud.websecurityscanner.v1beta.Finding

Namespace

Google \ Cloud \ WebSecurityScanner \ V1beta

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

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.

↳ finding_type
string

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

↳ http_method
string

The http method of the request that triggered the vulnerability, in uppercase.

↳ fuzzed_url
string

The URL produced by the server-side fuzzer and used in the request that triggered the vulnerability.

↳ body
string

The body of the request that triggered the vulnerability.

↳ description
string

The description of the vulnerability.

↳ reproduction_url
string

The URL containing human-readable payload that user can leverage to reproduce the vulnerability.

↳ frame_url
string

If the vulnerability was originated from nested IFrame, the immediate parent IFrame is reported.

↳ final_url
string

The URL where the browser lands when the vulnerability is detected.

↳ tracking_id
string

The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns.

↳ form
Google\Cloud\WebSecurityScanner\V1beta\Form

An addon containing information reported for a vulnerability with an HTML form, if any.

↳ outdated_library
Google\Cloud\WebSecurityScanner\V1beta\OutdatedLibrary

An addon containing information about outdated libraries.

↳ violating_resource
Google\Cloud\WebSecurityScanner\V1beta\ViolatingResource

An addon containing detailed information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc.

↳ vulnerable_headers
Google\Cloud\WebSecurityScanner\V1beta\VulnerableHeaders

An addon containing information about vulnerable or missing HTTP headers.

↳ vulnerable_parameters
Google\Cloud\WebSecurityScanner\V1beta\VulnerableParameters

An addon containing information about request parameters which were found to be vulnerable.

↳ xss
Google\Cloud\WebSecurityScanner\V1beta\Xss

An addon containing information reported for an XSS, if any.

getName

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.

Returns
Type
Description
string

setName

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.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getFindingType

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

Returns
Type
Description
string

setFindingType

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getHttpMethod

The http method of the request that triggered the vulnerability, in uppercase.

Returns
Type
Description
string

setHttpMethod

The http method of the request that triggered the vulnerability, in uppercase.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getFuzzedUrl

The URL produced by the server-side fuzzer and used in the request that triggered the vulnerability.

Returns
Type
Description
string

setFuzzedUrl

The URL produced by the server-side fuzzer and used in the request that triggered the vulnerability.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getBody

The body of the request that triggered the vulnerability.

Returns
Type
Description
string

setBody

The body of the request that triggered the vulnerability.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDescription

The description of the vulnerability.

Returns
Type
Description
string

setDescription

The description of the vulnerability.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getReproductionUrl

The URL containing human-readable payload that user can leverage to reproduce the vulnerability.

Returns
Type
Description
string

setReproductionUrl

The URL containing human-readable payload that user can leverage to reproduce the vulnerability.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getFrameUrl

If the vulnerability was originated from nested IFrame, the immediate parent IFrame is reported.

Returns
Type
Description
string

setFrameUrl

If the vulnerability was originated from nested IFrame, the immediate parent IFrame is reported.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getFinalUrl

The URL where the browser lands when the vulnerability is detected.

Returns
Type
Description
string

setFinalUrl

The URL where the browser lands when the vulnerability is detected.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getTrackingId

The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns.

Returns
Type
Description
string

setTrackingId

The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getForm

An addon containing information reported for a vulnerability with an HTML form, if any.

Returns
Type
Description

hasForm

clearForm

setForm

An addon containing information reported for a vulnerability with an HTML form, if any.

Parameter
Name
Description
Returns
Type
Description
$this

getOutdatedLibrary

An addon containing information about outdated libraries.

hasOutdatedLibrary

clearOutdatedLibrary

setOutdatedLibrary

An addon containing information about outdated libraries.

Returns
Type
Description
$this

getViolatingResource

An addon containing detailed information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc.

hasViolatingResource

clearViolatingResource

setViolatingResource

An addon containing detailed information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc.

Returns
Type
Description
$this

getVulnerableHeaders

An addon containing information about vulnerable or missing HTTP headers.

hasVulnerableHeaders

clearVulnerableHeaders

setVulnerableHeaders

An addon containing information about vulnerable or missing HTTP headers.

Returns
Type
Description
$this

getVulnerableParameters

An addon containing information about request parameters which were found to be vulnerable.

hasVulnerableParameters

clearVulnerableParameters

setVulnerableParameters

An addon containing information about request parameters which were found to be vulnerable.

Returns
Type
Description
$this

getXss

An addon containing information reported for an XSS, if any.

Returns
Type
Description

hasXss

clearXss

setXss

An addon containing information reported for an XSS, if any.

Parameter
Name
Description
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: