The interfaces provided are listed below, along with usage samples.
WebSecurityScannerClient
Service Description: Cloud Web Security Scanner Service identifies security vulnerabilities in web applications hosted on Google Cloud Platform. It crawls your application, and attempts to exercise as many user inputs and event handlers as possible.
Sample for WebSecurityScannerClient:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
ProjectName parent = ProjectName.of("[PROJECT]");
ScanConfig scanConfig = ScanConfig.newBuilder().build();
ScanConfig response = webSecurityScannerClient.createScanConfig(parent, scanConfig);
}
Classes
CrawledUrl
A CrawledUrl resource represents a URL that was crawled during a ScanRun. Web Security Scanner Service crawls the web applications, following all links within the scope of sites, to find the URLs to test against.
Protobuf type google.cloud.websecurityscanner.v1beta.CrawledUrl
CrawledUrl.Builder
A CrawledUrl resource represents a URL that was crawled during a ScanRun. Web Security Scanner Service crawls the web applications, following all links within the scope of sites, to find the URLs to test against.
Protobuf type google.cloud.websecurityscanner.v1beta.CrawledUrl
CrawledUrlProto
CreateScanConfigRequest
Request for the CreateScanConfig method.
Protobuf type google.cloud.websecurityscanner.v1beta.CreateScanConfigRequest
CreateScanConfigRequest.Builder
Request for the CreateScanConfig method.
Protobuf type google.cloud.websecurityscanner.v1beta.CreateScanConfigRequest
DeleteScanConfigRequest
Request for the DeleteScanConfig method.
Protobuf type google.cloud.websecurityscanner.v1beta.DeleteScanConfigRequest
DeleteScanConfigRequest.Builder
Request for the DeleteScanConfig method.
Protobuf type google.cloud.websecurityscanner.v1beta.DeleteScanConfigRequest
Finding
A Finding resource represents a vulnerability instance identified during a ScanRun.
Protobuf type google.cloud.websecurityscanner.v1beta.Finding
Finding.Builder
A Finding resource represents a vulnerability instance identified during a ScanRun.
Protobuf type google.cloud.websecurityscanner.v1beta.Finding
FindingAddonProto
FindingName
FindingName.Builder
Builder for projects/{project}/scanConfigs/{scan_config}/scanRuns/{scan_run}/findings/{finding}.
FindingProto
FindingTypeStats
A FindingTypeStats resource represents stats regarding a specific FindingType of Findings under a given ScanRun.
Protobuf type google.cloud.websecurityscanner.v1beta.FindingTypeStats
FindingTypeStats.Builder
A FindingTypeStats resource represents stats regarding a specific FindingType of Findings under a given ScanRun.
Protobuf type google.cloud.websecurityscanner.v1beta.FindingTypeStats
FindingTypeStatsProto
Form
! Information about a vulnerability with an HTML.
Protobuf type google.cloud.websecurityscanner.v1beta.Form
Form.Builder
! Information about a vulnerability with an HTML.
Protobuf type google.cloud.websecurityscanner.v1beta.Form
GetFindingRequest
Request for the GetFinding method.
Protobuf type google.cloud.websecurityscanner.v1beta.GetFindingRequest
GetFindingRequest.Builder
Request for the GetFinding method.
Protobuf type google.cloud.websecurityscanner.v1beta.GetFindingRequest
GetScanConfigRequest
Request for the GetScanConfig method.
Protobuf type google.cloud.websecurityscanner.v1beta.GetScanConfigRequest
GetScanConfigRequest.Builder
Request for the GetScanConfig method.
Protobuf type google.cloud.websecurityscanner.v1beta.GetScanConfigRequest
GetScanRunRequest
Request for the GetScanRun method.
Protobuf type google.cloud.websecurityscanner.v1beta.GetScanRunRequest
GetScanRunRequest.Builder
Request for the GetScanRun method.
Protobuf type google.cloud.websecurityscanner.v1beta.GetScanRunRequest
ListCrawledUrlsRequest
Request for the ListCrawledUrls method.
Protobuf type google.cloud.websecurityscanner.v1beta.ListCrawledUrlsRequest
ListCrawledUrlsRequest.Builder
Request for the ListCrawledUrls method.
Protobuf type google.cloud.websecurityscanner.v1beta.ListCrawledUrlsRequest
ListCrawledUrlsResponse
Response for the ListCrawledUrls method.
Protobuf type google.cloud.websecurityscanner.v1beta.ListCrawledUrlsResponse
ListCrawledUrlsResponse.Builder
Response for the ListCrawledUrls method.
Protobuf type google.cloud.websecurityscanner.v1beta.ListCrawledUrlsResponse
ListFindingTypeStatsRequest
Request for the ListFindingTypeStats method.
Protobuf type google.cloud.websecurityscanner.v1beta.ListFindingTypeStatsRequest
ListFindingTypeStatsRequest.Builder
Request for the ListFindingTypeStats method.
Protobuf type google.cloud.websecurityscanner.v1beta.ListFindingTypeStatsRequest
ListFindingTypeStatsResponse
Response for the ListFindingTypeStats method.
Protobuf type google.cloud.websecurityscanner.v1beta.ListFindingTypeStatsResponse
ListFindingTypeStatsResponse.Builder
Response for the ListFindingTypeStats method.
Protobuf type google.cloud.websecurityscanner.v1beta.ListFindingTypeStatsResponse
ListFindingsRequest
Request for the ListFindings method.
Protobuf type google.cloud.websecurityscanner.v1beta.ListFindingsRequest
ListFindingsRequest.Builder
Request for the ListFindings method.
Protobuf type google.cloud.websecurityscanner.v1beta.ListFindingsRequest
ListFindingsResponse
Response for the ListFindings method.
Protobuf type google.cloud.websecurityscanner.v1beta.ListFindingsResponse
ListFindingsResponse.Builder
Response for the ListFindings method.
Protobuf type google.cloud.websecurityscanner.v1beta.ListFindingsResponse
ListScanConfigsRequest
Request for the ListScanConfigs method.
Protobuf type google.cloud.websecurityscanner.v1beta.ListScanConfigsRequest
ListScanConfigsRequest.Builder
Request for the ListScanConfigs method.
Protobuf type google.cloud.websecurityscanner.v1beta.ListScanConfigsRequest
ListScanConfigsResponse
Response for the ListScanConfigs method.
Protobuf type google.cloud.websecurityscanner.v1beta.ListScanConfigsResponse
ListScanConfigsResponse.Builder
Response for the ListScanConfigs method.
Protobuf type google.cloud.websecurityscanner.v1beta.ListScanConfigsResponse
ListScanRunsRequest
Request for the ListScanRuns method.
Protobuf type google.cloud.websecurityscanner.v1beta.ListScanRunsRequest
ListScanRunsRequest.Builder
Request for the ListScanRuns method.
Protobuf type google.cloud.websecurityscanner.v1beta.ListScanRunsRequest
ListScanRunsResponse
Response for the ListScanRuns method.
Protobuf type google.cloud.websecurityscanner.v1beta.ListScanRunsResponse
ListScanRunsResponse.Builder
Response for the ListScanRuns method.
Protobuf type google.cloud.websecurityscanner.v1beta.ListScanRunsResponse
OutdatedLibrary
Information reported for an outdated library.
Protobuf type google.cloud.websecurityscanner.v1beta.OutdatedLibrary
OutdatedLibrary.Builder
Information reported for an outdated library.
Protobuf type google.cloud.websecurityscanner.v1beta.OutdatedLibrary
ProjectName
ProjectName.Builder
Builder for projects/{project}.
ScanConfig
A ScanConfig resource contains the configurations to launch a scan.
Protobuf type google.cloud.websecurityscanner.v1beta.ScanConfig
ScanConfig.Authentication
Scan authentication configuration.
Protobuf type google.cloud.websecurityscanner.v1beta.ScanConfig.Authentication
ScanConfig.Authentication.Builder
Scan authentication configuration.
Protobuf type google.cloud.websecurityscanner.v1beta.ScanConfig.Authentication
ScanConfig.Authentication.CustomAccount
Describes authentication configuration that uses a custom account.
Protobuf type
google.cloud.websecurityscanner.v1beta.ScanConfig.Authentication.CustomAccount
ScanConfig.Authentication.CustomAccount.Builder
Describes authentication configuration that uses a custom account.
Protobuf type
google.cloud.websecurityscanner.v1beta.ScanConfig.Authentication.CustomAccount
ScanConfig.Authentication.GoogleAccount
Describes authentication configuration that uses a Google account.
Protobuf type
google.cloud.websecurityscanner.v1beta.ScanConfig.Authentication.GoogleAccount
ScanConfig.Authentication.GoogleAccount.Builder
Describes authentication configuration that uses a Google account.
Protobuf type
google.cloud.websecurityscanner.v1beta.ScanConfig.Authentication.GoogleAccount
ScanConfig.Builder
A ScanConfig resource contains the configurations to launch a scan.
Protobuf type google.cloud.websecurityscanner.v1beta.ScanConfig
ScanConfig.Schedule
Scan schedule configuration.
Protobuf type google.cloud.websecurityscanner.v1beta.ScanConfig.Schedule
ScanConfig.Schedule.Builder
Scan schedule configuration.
Protobuf type google.cloud.websecurityscanner.v1beta.ScanConfig.Schedule
ScanConfigError
Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error.
Protobuf type google.cloud.websecurityscanner.v1beta.ScanConfigError
ScanConfigError.Builder
Defines a custom error message used by CreateScanConfig and UpdateScanConfig APIs when scan configuration validation fails. It is also reported as part of a ScanRunErrorTrace message if scan validation fails due to a scan configuration error.
Protobuf type google.cloud.websecurityscanner.v1beta.ScanConfigError
ScanConfigErrorProto
ScanConfigName
ScanConfigName.Builder
Builder for projects/{project}/scanConfigs/{scan_config}.
ScanConfigProto
ScanRun
A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12
Protobuf type google.cloud.websecurityscanner.v1beta.ScanRun
ScanRun.Builder
A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12
Protobuf type google.cloud.websecurityscanner.v1beta.ScanRun
ScanRunErrorTrace
Output only. Defines an error trace message for a ScanRun.
Protobuf type google.cloud.websecurityscanner.v1beta.ScanRunErrorTrace
ScanRunErrorTrace.Builder
Output only. Defines an error trace message for a ScanRun.
Protobuf type google.cloud.websecurityscanner.v1beta.ScanRunErrorTrace
ScanRunErrorTraceProto
ScanRunName
ScanRunName.Builder
Builder for projects/{project}/scanConfigs/{scan_config}/scanRuns/{scan_run}.
ScanRunProto
ScanRunWarningTrace
Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.
Protobuf type google.cloud.websecurityscanner.v1beta.ScanRunWarningTrace
ScanRunWarningTrace.Builder
Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.
Protobuf type google.cloud.websecurityscanner.v1beta.ScanRunWarningTrace
ScanRunWarningTraceProto
StartScanRunRequest
Request for the StartScanRun method.
Protobuf type google.cloud.websecurityscanner.v1beta.StartScanRunRequest
StartScanRunRequest.Builder
Request for the StartScanRun method.
Protobuf type google.cloud.websecurityscanner.v1beta.StartScanRunRequest
StopScanRunRequest
Request for the StopScanRun method.
Protobuf type google.cloud.websecurityscanner.v1beta.StopScanRunRequest
StopScanRunRequest.Builder
Request for the StopScanRun method.
Protobuf type google.cloud.websecurityscanner.v1beta.StopScanRunRequest
UpdateScanConfigRequest
Request for the UpdateScanConfigRequest method.
Protobuf type google.cloud.websecurityscanner.v1beta.UpdateScanConfigRequest
UpdateScanConfigRequest.Builder
Request for the UpdateScanConfigRequest method.
Protobuf type google.cloud.websecurityscanner.v1beta.UpdateScanConfigRequest
ViolatingResource
Information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc.
Protobuf type google.cloud.websecurityscanner.v1beta.ViolatingResource
ViolatingResource.Builder
Information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc.
Protobuf type google.cloud.websecurityscanner.v1beta.ViolatingResource
VulnerableHeaders
Information about vulnerable or missing HTTP Headers.
Protobuf type google.cloud.websecurityscanner.v1beta.VulnerableHeaders
VulnerableHeaders.Builder
Information about vulnerable or missing HTTP Headers.
Protobuf type google.cloud.websecurityscanner.v1beta.VulnerableHeaders
VulnerableHeaders.Header
Describes a HTTP Header.
Protobuf type google.cloud.websecurityscanner.v1beta.VulnerableHeaders.Header
VulnerableHeaders.Header.Builder
Describes a HTTP Header.
Protobuf type google.cloud.websecurityscanner.v1beta.VulnerableHeaders.Header
VulnerableParameters
Information about vulnerable request parameters.
Protobuf type google.cloud.websecurityscanner.v1beta.VulnerableParameters
VulnerableParameters.Builder
Information about vulnerable request parameters.
Protobuf type google.cloud.websecurityscanner.v1beta.VulnerableParameters
WebSecurityScannerClient
Service Description: Cloud Web Security Scanner Service identifies security vulnerabilities in web applications hosted on Google Cloud Platform. It crawls your application, and attempts to exercise as many user inputs and event handlers as possible.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
ProjectName parent = ProjectName.of("[PROJECT]");
ScanConfig scanConfig = ScanConfig.newBuilder().build();
ScanConfig response = webSecurityScannerClient.createScanConfig(parent, scanConfig);
}
Note: close() needs to be called on the WebSecurityScannerClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of WebSecurityScannerSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
WebSecurityScannerSettings webSecurityScannerSettings =
WebSecurityScannerSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
WebSecurityScannerClient webSecurityScannerClient =
WebSecurityScannerClient.create(webSecurityScannerSettings);
To customize the endpoint:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
WebSecurityScannerSettings webSecurityScannerSettings =
WebSecurityScannerSettings.newBuilder().setEndpoint(myEndpoint).build();
WebSecurityScannerClient webSecurityScannerClient =
WebSecurityScannerClient.create(webSecurityScannerSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
WebSecurityScannerSettings webSecurityScannerSettings =
WebSecurityScannerSettings.newBuilder()
.setTransportChannelProvider(
WebSecurityScannerSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
WebSecurityScannerClient webSecurityScannerClient =
WebSecurityScannerClient.create(webSecurityScannerSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
WebSecurityScannerClient.ListCrawledUrlsFixedSizeCollection
WebSecurityScannerClient.ListCrawledUrlsPage
WebSecurityScannerClient.ListCrawledUrlsPagedResponse
WebSecurityScannerClient.ListFindingsFixedSizeCollection
WebSecurityScannerClient.ListFindingsPage
WebSecurityScannerClient.ListFindingsPagedResponse
WebSecurityScannerClient.ListScanConfigsFixedSizeCollection
WebSecurityScannerClient.ListScanConfigsPage
WebSecurityScannerClient.ListScanConfigsPagedResponse
WebSecurityScannerClient.ListScanRunsFixedSizeCollection
WebSecurityScannerClient.ListScanRunsPage
WebSecurityScannerClient.ListScanRunsPagedResponse
WebSecurityScannerGrpc
Cloud Web Security Scanner Service identifies security vulnerabilities in web applications hosted on Google Cloud Platform. It crawls your application, and attempts to exercise as many user inputs and event handlers as possible.
WebSecurityScannerGrpc.WebSecurityScannerBlockingStub
Cloud Web Security Scanner Service identifies security vulnerabilities in web applications hosted on Google Cloud Platform. It crawls your application, and attempts to exercise as many user inputs and event handlers as possible.
WebSecurityScannerGrpc.WebSecurityScannerFutureStub
Cloud Web Security Scanner Service identifies security vulnerabilities in web applications hosted on Google Cloud Platform. It crawls your application, and attempts to exercise as many user inputs and event handlers as possible.
WebSecurityScannerGrpc.WebSecurityScannerImplBase
Cloud Web Security Scanner Service identifies security vulnerabilities in web applications hosted on Google Cloud Platform. It crawls your application, and attempts to exercise as many user inputs and event handlers as possible.
WebSecurityScannerGrpc.WebSecurityScannerStub
Cloud Web Security Scanner Service identifies security vulnerabilities in web applications hosted on Google Cloud Platform. It crawls your application, and attempts to exercise as many user inputs and event handlers as possible.
WebSecurityScannerProto
WebSecurityScannerSettings
Settings class to configure an instance of WebSecurityScannerClient.
The default instance has everything set to sensible defaults:
- The default service address (websecurityscanner.googleapis.com) and default port (443) are used.
- Credentials are acquired automatically through Application Default Credentials.
- Retries are configured for idempotent methods but not for non-idempotent methods.
The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.
For example, to set the total timeout of createScanConfig to 30 seconds:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
WebSecurityScannerSettings.Builder webSecurityScannerSettingsBuilder =
WebSecurityScannerSettings.newBuilder();
webSecurityScannerSettingsBuilder
.createScanConfigSettings()
.setRetrySettings(
webSecurityScannerSettingsBuilder
.createScanConfigSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
WebSecurityScannerSettings webSecurityScannerSettings =
webSecurityScannerSettingsBuilder.build();
WebSecurityScannerSettings.Builder
Builder for WebSecurityScannerSettings.
Xss
Information reported for an XSS.
Protobuf type google.cloud.websecurityscanner.v1beta.Xss
Xss.Builder
Information reported for an XSS.
Protobuf type google.cloud.websecurityscanner.v1beta.Xss
Interfaces
CrawledUrlOrBuilder
CreateScanConfigRequestOrBuilder
DeleteScanConfigRequestOrBuilder
FindingOrBuilder
FindingTypeStatsOrBuilder
FormOrBuilder
GetFindingRequestOrBuilder
GetScanConfigRequestOrBuilder
GetScanRunRequestOrBuilder
ListCrawledUrlsRequestOrBuilder
ListCrawledUrlsResponseOrBuilder
ListFindingTypeStatsRequestOrBuilder
ListFindingTypeStatsResponseOrBuilder
ListFindingsRequestOrBuilder
ListFindingsResponseOrBuilder
ListScanConfigsRequestOrBuilder
ListScanConfigsResponseOrBuilder
ListScanRunsRequestOrBuilder
ListScanRunsResponseOrBuilder
OutdatedLibraryOrBuilder
ScanConfig.Authentication.CustomAccountOrBuilder
ScanConfig.Authentication.GoogleAccountOrBuilder
ScanConfig.AuthenticationOrBuilder
ScanConfig.ScheduleOrBuilder
ScanConfigErrorOrBuilder
ScanConfigOrBuilder
ScanRunErrorTraceOrBuilder
ScanRunOrBuilder
ScanRunWarningTraceOrBuilder
StartScanRunRequestOrBuilder
StopScanRunRequestOrBuilder
UpdateScanConfigRequestOrBuilder
ViolatingResourceOrBuilder
VulnerableHeaders.HeaderOrBuilder
VulnerableHeadersOrBuilder
VulnerableParametersOrBuilder
XssOrBuilder
Enums
ScanConfig.Authentication.AuthenticationCase
ScanConfig.ExportToSecurityCommandCenter
Controls export of scan configurations and results to Cloud Security Command Center.
Protobuf enum
google.cloud.websecurityscanner.v1beta.ScanConfig.ExportToSecurityCommandCenter
ScanConfig.RiskLevel
Scan risk levels supported by Cloud Web Security Scanner. LOW impact scanning will minimize requests with the potential to modify data. To achieve the maximum scan coverage, NORMAL risk level is recommended.
Protobuf enum google.cloud.websecurityscanner.v1beta.ScanConfig.RiskLevel
ScanConfig.TargetPlatform
Cloud platforms supported by Cloud Web Security Scanner.
Protobuf enum google.cloud.websecurityscanner.v1beta.ScanConfig.TargetPlatform
ScanConfig.UserAgent
Type of user agents used for scanning.
Protobuf enum google.cloud.websecurityscanner.v1beta.ScanConfig.UserAgent
ScanConfigError.Code
Output only. Defines an error reason code. Next id: 44
Protobuf enum google.cloud.websecurityscanner.v1beta.ScanConfigError.Code
ScanRun.ExecutionState
Types of ScanRun execution state.
Protobuf enum google.cloud.websecurityscanner.v1beta.ScanRun.ExecutionState
ScanRun.ResultState
Types of ScanRun result state.
Protobuf enum google.cloud.websecurityscanner.v1beta.ScanRun.ResultState
ScanRunErrorTrace.Code
Output only. Defines an error reason code. Next id: 7
Protobuf enum google.cloud.websecurityscanner.v1beta.ScanRunErrorTrace.Code
ScanRunWarningTrace.Code
Output only. Defines a warning message code. Next id: 6
Protobuf enum google.cloud.websecurityscanner.v1beta.ScanRunWarningTrace.Code