Package com.google.cloud.websecurityscanner.v1alpha (2.5.0)

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

Request for the CreateScanConfig method.

Protobuf type google.cloud.websecurityscanner.v1alpha.CreateScanConfigRequest

Request for the CreateScanConfig method.

Protobuf type google.cloud.websecurityscanner.v1alpha.CreateScanConfigRequest

Request for the DeleteScanConfig method.

Protobuf type google.cloud.websecurityscanner.v1alpha.DeleteScanConfigRequest

Request for the DeleteScanConfig method.

Protobuf type google.cloud.websecurityscanner.v1alpha.DeleteScanConfigRequest

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

Protobuf type google.cloud.websecurityscanner.v1alpha.Finding

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

Protobuf type google.cloud.websecurityscanner.v1alpha.Finding

Builder for projects/{project}/scanConfigs/{scan_config}/scanRuns/{scan_run}/findings/{finding}.

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

Protobuf type google.cloud.websecurityscanner.v1alpha.FindingTypeStats

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

Protobuf type google.cloud.websecurityscanner.v1alpha.FindingTypeStats

Request for the GetFinding method.

Protobuf type google.cloud.websecurityscanner.v1alpha.GetFindingRequest

Request for the GetFinding method.

Protobuf type google.cloud.websecurityscanner.v1alpha.GetFindingRequest

Request for the GetScanConfig method.

Protobuf type google.cloud.websecurityscanner.v1alpha.GetScanConfigRequest

Request for the GetScanConfig method.

Protobuf type google.cloud.websecurityscanner.v1alpha.GetScanConfigRequest

Request for the GetScanRun method.

Protobuf type google.cloud.websecurityscanner.v1alpha.GetScanRunRequest

Request for the GetScanRun method.

Protobuf type google.cloud.websecurityscanner.v1alpha.GetScanRunRequest

Request for the ListCrawledUrls method.

Protobuf type google.cloud.websecurityscanner.v1alpha.ListCrawledUrlsRequest

Request for the ListCrawledUrls method.

Protobuf type google.cloud.websecurityscanner.v1alpha.ListCrawledUrlsRequest

Response for the ListCrawledUrls method.

Protobuf type google.cloud.websecurityscanner.v1alpha.ListCrawledUrlsResponse

Response for the ListCrawledUrls method.

Protobuf type google.cloud.websecurityscanner.v1alpha.ListCrawledUrlsResponse

Request for the ListFindingTypeStats method.

Protobuf type google.cloud.websecurityscanner.v1alpha.ListFindingTypeStatsRequest

Request for the ListFindingTypeStats method.

Protobuf type google.cloud.websecurityscanner.v1alpha.ListFindingTypeStatsRequest

Response for the ListFindingTypeStats method.

Protobuf type google.cloud.websecurityscanner.v1alpha.ListFindingTypeStatsResponse

Response for the ListFindingTypeStats method.

Protobuf type google.cloud.websecurityscanner.v1alpha.ListFindingTypeStatsResponse

Request for the ListFindings method.

Protobuf type google.cloud.websecurityscanner.v1alpha.ListFindingsRequest

Request for the ListFindings method.

Protobuf type google.cloud.websecurityscanner.v1alpha.ListFindingsRequest

Response for the ListFindings method.

Protobuf type google.cloud.websecurityscanner.v1alpha.ListFindingsResponse

Response for the ListFindings method.

Protobuf type google.cloud.websecurityscanner.v1alpha.ListFindingsResponse

Request for the ListScanConfigs method.

Protobuf type google.cloud.websecurityscanner.v1alpha.ListScanConfigsRequest

Request for the ListScanConfigs method.

Protobuf type google.cloud.websecurityscanner.v1alpha.ListScanConfigsRequest

Response for the ListScanConfigs method.

Protobuf type google.cloud.websecurityscanner.v1alpha.ListScanConfigsResponse

Response for the ListScanConfigs method.

Protobuf type google.cloud.websecurityscanner.v1alpha.ListScanConfigsResponse

Request for the ListScanRuns method.

Protobuf type google.cloud.websecurityscanner.v1alpha.ListScanRunsRequest

Request for the ListScanRuns method.

Protobuf type google.cloud.websecurityscanner.v1alpha.ListScanRunsRequest

Response for the ListScanRuns method.

Protobuf type google.cloud.websecurityscanner.v1alpha.ListScanRunsResponse

Response for the ListScanRuns method.

Protobuf type google.cloud.websecurityscanner.v1alpha.ListScanRunsResponse

Information reported for an outdated library.

Protobuf type google.cloud.websecurityscanner.v1alpha.OutdatedLibrary

Information reported for an outdated library.

Protobuf type google.cloud.websecurityscanner.v1alpha.OutdatedLibrary

Builder for projects/{project}.

A ScanConfig resource contains the configurations to launch a scan. next id: 12

Protobuf type google.cloud.websecurityscanner.v1alpha.ScanConfig

Scan authentication configuration.

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

Scan authentication configuration.

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

Describes authentication configuration that uses a custom account.

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

Describes authentication configuration that uses a custom account.

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

Describes authentication configuration that uses a Google account.

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

Describes authentication configuration that uses a Google account.

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

A ScanConfig resource contains the configurations to launch a scan. next id: 12

Protobuf type google.cloud.websecurityscanner.v1alpha.ScanConfig

Scan schedule configuration.

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

Scan schedule configuration.

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

Builder for projects/{project}/scanConfigs/{scan_config}.

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

Protobuf type google.cloud.websecurityscanner.v1alpha.ScanRun

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

Protobuf type google.cloud.websecurityscanner.v1alpha.ScanRun

Builder for projects/{project}/scanConfigs/{scan_config}/scanRuns/{scan_run}.

Request for the StartScanRun method.

Protobuf type google.cloud.websecurityscanner.v1alpha.StartScanRunRequest

Request for the StartScanRun method.

Protobuf type google.cloud.websecurityscanner.v1alpha.StartScanRunRequest

Request for the StopScanRun method.

Protobuf type google.cloud.websecurityscanner.v1alpha.StopScanRunRequest

Request for the StopScanRun method.

Protobuf type google.cloud.websecurityscanner.v1alpha.StopScanRunRequest

Request for the UpdateScanConfigRequest method.

Protobuf type google.cloud.websecurityscanner.v1alpha.UpdateScanConfigRequest

Request for the UpdateScanConfigRequest method.

Protobuf type google.cloud.websecurityscanner.v1alpha.UpdateScanConfigRequest

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

Protobuf type google.cloud.websecurityscanner.v1alpha.ViolatingResource

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

Protobuf type google.cloud.websecurityscanner.v1alpha.ViolatingResource

Information about vulnerable or missing HTTP Headers.

Protobuf type google.cloud.websecurityscanner.v1alpha.VulnerableHeaders

Information about vulnerable or missing HTTP Headers.

Protobuf type google.cloud.websecurityscanner.v1alpha.VulnerableHeaders

Describes a HTTP Header.

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

Describes a HTTP Header.

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

Information about vulnerable request parameters.

Protobuf type google.cloud.websecurityscanner.v1alpha.VulnerableParameters

Information about vulnerable request parameters.

Protobuf type google.cloud.websecurityscanner.v1alpha.VulnerableParameters

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 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()) {
   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:

1. 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.
2. 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.
3. 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.newBuilder()
         .setTransportChannelProvider(
             WebSecurityScannerSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 WebSecurityScannerClient webSecurityScannerClient =
     WebSecurityScannerClient.create(webSecurityScannerSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

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.

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.

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.

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.

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.

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();
 

Builder for WebSecurityScannerSettings.

Information reported for an XSS.

Protobuf type google.cloud.websecurityscanner.v1alpha.Xss

Information reported for an XSS.

Protobuf type google.cloud.websecurityscanner.v1alpha.Xss

Types of Findings.

Protobuf enum google.cloud.websecurityscanner.v1alpha.Finding.FindingType

Cloud platforms supported by Cloud Web Security Scanner.

Protobuf enum google.cloud.websecurityscanner.v1alpha.ScanConfig.TargetPlatform

Type of user agents used for scanning.

Protobuf enum google.cloud.websecurityscanner.v1alpha.ScanConfig.UserAgent

Types of ScanRun execution state.

Protobuf enum google.cloud.websecurityscanner.v1alpha.ScanRun.ExecutionState

Types of ScanRun result state.

Protobuf enum google.cloud.websecurityscanner.v1alpha.ScanRun.ResultState