Package com.google.cloud.websecurityscanner.v1 (2.8.0)

A client to Web Security Scanner API

The interfaces provided are listed below, along with usage samples.

WebSecurityScannerClient

Service Description: Web Security Scanner Service identifies security vulnerabilities in web applications hosted on Google Cloud. 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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
   CreateScanConfigRequest request =
       CreateScanConfigRequest.newBuilder()
           .setParent("parent-995424086")
           .setScanConfig(ScanConfig.newBuilder().build())
           .build();
   ScanConfig response = webSecurityScannerClient.createScanConfig(request);
 }

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.v1.CrawledUrl

CrawledUrl.Builder

Protobuf type google.cloud.websecurityscanner.v1.CrawledUrl

CrawledUrlProto

CreateScanConfigRequest

Request for the CreateScanConfig method.

Protobuf type google.cloud.websecurityscanner.v1.CreateScanConfigRequest

CreateScanConfigRequest.Builder

Request for the CreateScanConfig method.

Protobuf type google.cloud.websecurityscanner.v1.CreateScanConfigRequest

DeleteScanConfigRequest

Request for the DeleteScanConfig method.

Protobuf type google.cloud.websecurityscanner.v1.DeleteScanConfigRequest

DeleteScanConfigRequest.Builder

Request for the DeleteScanConfig method.

Protobuf type google.cloud.websecurityscanner.v1.DeleteScanConfigRequest

Finding

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

Protobuf type google.cloud.websecurityscanner.v1.Finding

Finding.Builder

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

Protobuf type google.cloud.websecurityscanner.v1.Finding

FindingAddonProto

FindingProto

FindingTypeStats

A FindingTypeStats resource represents stats regarding a specific FindingType of Findings under a given ScanRun.

Protobuf type google.cloud.websecurityscanner.v1.FindingTypeStats

FindingTypeStats.Builder

A FindingTypeStats resource represents stats regarding a specific FindingType of Findings under a given ScanRun.

Protobuf type google.cloud.websecurityscanner.v1.FindingTypeStats

FindingTypeStatsProto

Form

! Information about a vulnerability with an HTML.

Protobuf type google.cloud.websecurityscanner.v1.Form

Form.Builder

! Information about a vulnerability with an HTML.

Protobuf type google.cloud.websecurityscanner.v1.Form

GetFindingRequest

Request for the GetFinding method.

Protobuf type google.cloud.websecurityscanner.v1.GetFindingRequest

GetFindingRequest.Builder

Request for the GetFinding method.

Protobuf type google.cloud.websecurityscanner.v1.GetFindingRequest

GetScanConfigRequest

Request for the GetScanConfig method.

Protobuf type google.cloud.websecurityscanner.v1.GetScanConfigRequest

GetScanConfigRequest.Builder

Request for the GetScanConfig method.

Protobuf type google.cloud.websecurityscanner.v1.GetScanConfigRequest

GetScanRunRequest

Request for the GetScanRun method.

Protobuf type google.cloud.websecurityscanner.v1.GetScanRunRequest

GetScanRunRequest.Builder

Request for the GetScanRun method.

Protobuf type google.cloud.websecurityscanner.v1.GetScanRunRequest

ListCrawledUrlsRequest

Request for the ListCrawledUrls method.

Protobuf type google.cloud.websecurityscanner.v1.ListCrawledUrlsRequest

ListCrawledUrlsRequest.Builder

Request for the ListCrawledUrls method.

Protobuf type google.cloud.websecurityscanner.v1.ListCrawledUrlsRequest

ListCrawledUrlsResponse

Response for the ListCrawledUrls method.

Protobuf type google.cloud.websecurityscanner.v1.ListCrawledUrlsResponse

ListCrawledUrlsResponse.Builder

Response for the ListCrawledUrls method.

Protobuf type google.cloud.websecurityscanner.v1.ListCrawledUrlsResponse

ListFindingTypeStatsRequest

Request for the ListFindingTypeStats method.

Protobuf type google.cloud.websecurityscanner.v1.ListFindingTypeStatsRequest

ListFindingTypeStatsRequest.Builder

Request for the ListFindingTypeStats method.

Protobuf type google.cloud.websecurityscanner.v1.ListFindingTypeStatsRequest

ListFindingTypeStatsResponse

Response for the ListFindingTypeStats method.

Protobuf type google.cloud.websecurityscanner.v1.ListFindingTypeStatsResponse

ListFindingTypeStatsResponse.Builder

Response for the ListFindingTypeStats method.

Protobuf type google.cloud.websecurityscanner.v1.ListFindingTypeStatsResponse

ListFindingsRequest

Request for the ListFindings method.

Protobuf type google.cloud.websecurityscanner.v1.ListFindingsRequest

ListFindingsRequest.Builder

Request for the ListFindings method.

Protobuf type google.cloud.websecurityscanner.v1.ListFindingsRequest

ListFindingsResponse

Response for the ListFindings method.

Protobuf type google.cloud.websecurityscanner.v1.ListFindingsResponse

ListFindingsResponse.Builder

Response for the ListFindings method.

Protobuf type google.cloud.websecurityscanner.v1.ListFindingsResponse

ListScanConfigsRequest

Request for the ListScanConfigs method.

Protobuf type google.cloud.websecurityscanner.v1.ListScanConfigsRequest

ListScanConfigsRequest.Builder

Request for the ListScanConfigs method.

Protobuf type google.cloud.websecurityscanner.v1.ListScanConfigsRequest

ListScanConfigsResponse

Response for the ListScanConfigs method.

Protobuf type google.cloud.websecurityscanner.v1.ListScanConfigsResponse

ListScanConfigsResponse.Builder

Response for the ListScanConfigs method.

Protobuf type google.cloud.websecurityscanner.v1.ListScanConfigsResponse

ListScanRunsRequest

Request for the ListScanRuns method.

Protobuf type google.cloud.websecurityscanner.v1.ListScanRunsRequest

ListScanRunsRequest.Builder

Request for the ListScanRuns method.

Protobuf type google.cloud.websecurityscanner.v1.ListScanRunsRequest

ListScanRunsResponse

Response for the ListScanRuns method.

Protobuf type google.cloud.websecurityscanner.v1.ListScanRunsResponse

ListScanRunsResponse.Builder

Response for the ListScanRuns method.

Protobuf type google.cloud.websecurityscanner.v1.ListScanRunsResponse

OutdatedLibrary

Information reported for an outdated library.

Protobuf type google.cloud.websecurityscanner.v1.OutdatedLibrary

OutdatedLibrary.Builder

Information reported for an outdated library.

Protobuf type google.cloud.websecurityscanner.v1.OutdatedLibrary

ScanConfig

A ScanConfig resource contains the configurations to launch a scan.

Protobuf type google.cloud.websecurityscanner.v1.ScanConfig

ScanConfig.Authentication

Scan authentication configuration.

Protobuf type google.cloud.websecurityscanner.v1.ScanConfig.Authentication

ScanConfig.Authentication.Builder

Scan authentication configuration.

Protobuf type google.cloud.websecurityscanner.v1.ScanConfig.Authentication

ScanConfig.Authentication.CustomAccount

Describes authentication configuration that uses a custom account.

Protobuf type google.cloud.websecurityscanner.v1.ScanConfig.Authentication.CustomAccount

ScanConfig.Authentication.CustomAccount.Builder

Describes authentication configuration that uses a custom account.

Protobuf type google.cloud.websecurityscanner.v1.ScanConfig.Authentication.CustomAccount

ScanConfig.Authentication.GoogleAccount

Describes authentication configuration that uses a Google account.

Protobuf type google.cloud.websecurityscanner.v1.ScanConfig.Authentication.GoogleAccount

ScanConfig.Authentication.GoogleAccount.Builder

Describes authentication configuration that uses a Google account.

Protobuf type google.cloud.websecurityscanner.v1.ScanConfig.Authentication.GoogleAccount

ScanConfig.Authentication.IapCredential

Describes authentication configuration for Identity-Aware-Proxy (IAP).

Protobuf type google.cloud.websecurityscanner.v1.ScanConfig.Authentication.IapCredential

ScanConfig.Authentication.IapCredential.Builder

Describes authentication configuration for Identity-Aware-Proxy (IAP).

Protobuf type google.cloud.websecurityscanner.v1.ScanConfig.Authentication.IapCredential

ScanConfig.Authentication.IapCredential.IapTestServiceAccountInfo

Describes authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.

Protobuf type google.cloud.websecurityscanner.v1.ScanConfig.Authentication.IapCredential.IapTestServiceAccountInfo

ScanConfig.Authentication.IapCredential.IapTestServiceAccountInfo.Builder

Describes authentication configuration when Web-Security-Scanner service account is added in Identity-Aware-Proxy (IAP) access policies.

Protobuf type google.cloud.websecurityscanner.v1.ScanConfig.Authentication.IapCredential.IapTestServiceAccountInfo

ScanConfig.Builder

A ScanConfig resource contains the configurations to launch a scan.

Protobuf type google.cloud.websecurityscanner.v1.ScanConfig

ScanConfig.Schedule

Scan schedule configuration.

Protobuf type google.cloud.websecurityscanner.v1.ScanConfig.Schedule

ScanConfig.Schedule.Builder

Scan schedule configuration.

Protobuf type google.cloud.websecurityscanner.v1.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.v1.ScanConfigError

ScanConfigError.Builder

Protobuf type google.cloud.websecurityscanner.v1.ScanConfigError

ScanConfigErrorProto

ScanConfigProto

ScanRun

A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12

Protobuf type google.cloud.websecurityscanner.v1.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.v1.ScanRun

ScanRunErrorTrace

Output only. Defines an error trace message for a ScanRun.

Protobuf type google.cloud.websecurityscanner.v1.ScanRunErrorTrace

ScanRunErrorTrace.Builder

Output only. Defines an error trace message for a ScanRun.

Protobuf type google.cloud.websecurityscanner.v1.ScanRunErrorTrace

ScanRunErrorTraceProto

ScanRunLog

A ScanRunLog is an output-only proto used for Stackdriver customer logging. It is used for logs covering the start and end of scan pipelines. Other than an added summary, this is a subset of the ScanRun. Representation in logs is either a proto Struct, or converted to JSON. Next id: 9

Protobuf type google.cloud.websecurityscanner.v1.ScanRunLog

ScanRunLog.Builder

Protobuf type google.cloud.websecurityscanner.v1.ScanRunLog

ScanRunLogProto

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.v1.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.v1.ScanRunWarningTrace

ScanRunWarningTraceProto

StartScanRunRequest

Request for the StartScanRun method.

Protobuf type google.cloud.websecurityscanner.v1.StartScanRunRequest

StartScanRunRequest.Builder

Request for the StartScanRun method.

Protobuf type google.cloud.websecurityscanner.v1.StartScanRunRequest

StopScanRunRequest

Request for the StopScanRun method.

Protobuf type google.cloud.websecurityscanner.v1.StopScanRunRequest

StopScanRunRequest.Builder

Request for the StopScanRun method.

Protobuf type google.cloud.websecurityscanner.v1.StopScanRunRequest

UpdateScanConfigRequest

Request for the UpdateScanConfigRequest method.

Protobuf type google.cloud.websecurityscanner.v1.UpdateScanConfigRequest

UpdateScanConfigRequest.Builder

Request for the UpdateScanConfigRequest method.

Protobuf type google.cloud.websecurityscanner.v1.UpdateScanConfigRequest

ViolatingResource

Information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc.

Protobuf type google.cloud.websecurityscanner.v1.ViolatingResource

ViolatingResource.Builder

Information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc.

Protobuf type google.cloud.websecurityscanner.v1.ViolatingResource

VulnerableHeaders

Information about vulnerable or missing HTTP Headers.

Protobuf type google.cloud.websecurityscanner.v1.VulnerableHeaders

VulnerableHeaders.Builder

Information about vulnerable or missing HTTP Headers.

Protobuf type google.cloud.websecurityscanner.v1.VulnerableHeaders

Describes a HTTP Header.

Protobuf type google.cloud.websecurityscanner.v1.VulnerableHeaders.Header

Describes a HTTP Header.

Protobuf type google.cloud.websecurityscanner.v1.VulnerableHeaders.Header

VulnerableParameters

Information about vulnerable request parameters.

Protobuf type google.cloud.websecurityscanner.v1.VulnerableParameters

VulnerableParameters.Builder

Information about vulnerable request parameters.

Protobuf type google.cloud.websecurityscanner.v1.VulnerableParameters

WebSecurityScannerClient

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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (WebSecurityScannerClient webSecurityScannerClient = WebSecurityScannerClient.create()) {
   CreateScanConfigRequest request =
       CreateScanConfigRequest.newBuilder()
           .setParent("parent-995424086")
           .setScanConfig(ScanConfig.newBuilder().build())
           .build();
   ScanConfig response = webSecurityScannerClient.createScanConfig(request);
 }

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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 WebSecurityScannerSettings webSecurityScannerSettings =
     WebSecurityScannerSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 WebSecurityScannerClient webSecurityScannerClient =
     WebSecurityScannerClient.create(webSecurityScannerSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 WebSecurityScannerSettings webSecurityScannerSettings =
     WebSecurityScannerSettings.newHttpJsonBuilder().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

Web Security Scanner Service identifies security vulnerabilities in web applications hosted on Google Cloud. It crawls your application, and attempts to exercise as many user inputs and event handlers as possible.

WebSecurityScannerGrpc.WebSecurityScannerBlockingStub

WebSecurityScannerGrpc.WebSecurityScannerFutureStub

WebSecurityScannerGrpc.WebSecurityScannerImplBase

WebSecurityScannerGrpc.WebSecurityScannerStub

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 and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 WebSecurityScannerSettings.Builder webSecurityScannerSettingsBuilder =
     WebSecurityScannerSettings.newBuilder();
 webSecurityScannerSettingsBuilder
     .createScanConfigSettings()
     .setRetrySettings(
         webSecurityScannerSettingsBuilder
             .createScanConfigSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 WebSecurityScannerSettings webSecurityScannerSettings =
     webSecurityScannerSettingsBuilder.build();