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.
Equality
Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection>
objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
Constructors
WebSecurityScannerClient(WebSecurityScannerClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
WebSecurityScannerClient const &
|
WebSecurityScannerClient(WebSecurityScannerClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
WebSecurityScannerClient &&
|
WebSecurityScannerClient(std::shared_ptr< WebSecurityScannerConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< WebSecurityScannerConnection >
|
opts |
Options
|
Operators
operator=(WebSecurityScannerClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
WebSecurityScannerClient const &
|
Returns | |
---|---|
Type | Description |
WebSecurityScannerClient & |
operator=(WebSecurityScannerClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
WebSecurityScannerClient &&
|
Returns | |
---|---|
Type | Description |
WebSecurityScannerClient & |
Functions
CreateScanConfig(google::cloud::websecurityscanner::v1::CreateScanConfigRequest const &, Options)
Creates a new ScanConfig.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::websecurityscanner::v1::CreateScanConfigRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::websecurityscanner::v1::ScanConfig > |
the result of the RPC. The response message type (google.cloud.websecurityscanner.v1.ScanConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteScanConfig(google::cloud::websecurityscanner::v1::DeleteScanConfigRequest const &, Options)
Deletes an existing ScanConfig and its child resources.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::websecurityscanner::v1::DeleteScanConfigRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
Status |
a |
GetScanConfig(google::cloud::websecurityscanner::v1::GetScanConfigRequest const &, Options)
Gets a ScanConfig.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::websecurityscanner::v1::GetScanConfigRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::websecurityscanner::v1::ScanConfig > |
the result of the RPC. The response message type (google.cloud.websecurityscanner.v1.ScanConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListScanConfigs(google::cloud::websecurityscanner::v1::ListScanConfigsRequest, Options)
Lists ScanConfigs under a given project.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::websecurityscanner::v1::ListScanConfigsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::websecurityscanner::v1::ScanConfig > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
UpdateScanConfig(google::cloud::websecurityscanner::v1::UpdateScanConfigRequest const &, Options)
Updates a ScanConfig.
This method support partial update of a ScanConfig.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::websecurityscanner::v1::UpdateScanConfigRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::websecurityscanner::v1::ScanConfig > |
the result of the RPC. The response message type (google.cloud.websecurityscanner.v1.ScanConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
StartScanRun(google::cloud::websecurityscanner::v1::StartScanRunRequest const &, Options)
Start a ScanRun according to the given ScanConfig.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::websecurityscanner::v1::StartScanRunRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::websecurityscanner::v1::ScanRun > |
the result of the RPC. The response message type (google.cloud.websecurityscanner.v1.ScanRun) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetScanRun(google::cloud::websecurityscanner::v1::GetScanRunRequest const &, Options)
Gets a ScanRun.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::websecurityscanner::v1::GetScanRunRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::websecurityscanner::v1::ScanRun > |
the result of the RPC. The response message type (google.cloud.websecurityscanner.v1.ScanRun) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListScanRuns(google::cloud::websecurityscanner::v1::ListScanRunsRequest, Options)
Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::websecurityscanner::v1::ListScanRunsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::websecurityscanner::v1::ScanRun > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
StopScanRun(google::cloud::websecurityscanner::v1::StopScanRunRequest const &, Options)
Stops a ScanRun.
The stopped ScanRun is returned.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::websecurityscanner::v1::StopScanRunRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::websecurityscanner::v1::ScanRun > |
the result of the RPC. The response message type (google.cloud.websecurityscanner.v1.ScanRun) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListCrawledUrls(google::cloud::websecurityscanner::v1::ListCrawledUrlsRequest, Options)
List CrawledUrls under a given ScanRun.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::websecurityscanner::v1::ListCrawledUrlsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::websecurityscanner::v1::CrawledUrl > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetFinding(google::cloud::websecurityscanner::v1::GetFindingRequest const &, Options)
Gets a Finding.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::websecurityscanner::v1::GetFindingRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::websecurityscanner::v1::Finding > |
the result of the RPC. The response message type (google.cloud.websecurityscanner.v1.Finding) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListFindings(google::cloud::websecurityscanner::v1::ListFindingsRequest, Options)
List Findings under a given ScanRun.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::websecurityscanner::v1::ListFindingsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::websecurityscanner::v1::Finding > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListFindingTypeStats(google::cloud::websecurityscanner::v1::ListFindingTypeStatsRequest const &, Options)
List all FindingTypeStats under a given ScanRun.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::websecurityscanner::v1::ListFindingTypeStatsRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::websecurityscanner::v1::ListFindingTypeStatsResponse > |
the result of the RPC. The response message type (google.cloud.websecurityscanner.v1.ListFindingTypeStatsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |