package google.cloud.websecurityscanner.v1beta
Get desktop application:
View/edit binary Protocol Buffers messages
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.
Creates a new ScanConfig.
message
web_security_scanner.proto:156Request for the `CreateScanConfig` method.
string parent = 1
Required. The parent resource name where the scan is created, which should be a project resource name in the format 'projects/{projectId}'.
optional scan_config = 2
Required. The ScanConfig to be created.
Deletes an existing ScanConfig and its child resources.
message
web_security_scanner.proto:171Request for the `DeleteScanConfig` method.
string name = 1
Required. The resource name of the ScanConfig to be deleted. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.
Gets a ScanConfig.
message
web_security_scanner.proto:183Request for the `GetScanConfig` method.
string name = 1
Required. The resource name of the ScanConfig to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.
Lists ScanConfigs under a given project.
message
web_security_scanner.proto:195Request for the `ListScanConfigs` method.
string parent = 1
Required. The parent resource name, which should be a project resource name in the format 'projects/{projectId}'.
string page_token = 2
A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned.
int32 page_size = 3
The maximum number of ScanConfigs to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value.
message
web_security_scanner.proto:230Response for the `ListScanConfigs` method.
repeated scan_configs = 1
The list of ScanConfigs returned.
string next_page_token = 2
Token to retrieve the next page of results, or empty if there are no more results in the list.
Updates a ScanConfig. This method support partial update of a ScanConfig.
message
web_security_scanner.proto:217Request for the `UpdateScanConfigRequest` method.
optional scan_config = 2
Required. The ScanConfig to be updated. The name field must be set to identify the resource to be updated. The values of fields not covered by the mask will be ignored.
optional update_mask = 3
Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
Start a ScanRun according to the given ScanConfig.
message
web_security_scanner.proto:240Request for the `StartScanRun` method.
string name = 1
Required. The resource name of the ScanConfig to be used. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'.
Gets a ScanRun.
message
web_security_scanner.proto:252Request for the `GetScanRun` method.
string name = 1
Required. The resource name of the ScanRun to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
Lists ScanRuns under a given ScanConfig, in descending order of ScanRun stop time.
message
web_security_scanner.proto:265Request for the `ListScanRuns` method.
string parent = 1
Required. The parent resource name, which should be a scan resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}'.
string page_token = 2
A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned.
int32 page_size = 3
The maximum number of ScanRuns to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value.
message
web_security_scanner.proto:287Response for the `ListScanRuns` method.
repeated scan_runs = 1
The list of ScanRuns returned.
string next_page_token = 2
Token to retrieve the next page of results, or empty if there are no more results in the list.
Stops a ScanRun. The stopped ScanRun is returned.
message
web_security_scanner.proto:297Request for the `StopScanRun` method.
string name = 1
Required. The resource name of the ScanRun to be stopped. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
List CrawledUrls under a given ScanRun.
message
web_security_scanner.proto:310Request for the `ListCrawledUrls` method.
string parent = 1
Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
string page_token = 2
A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned.
int32 page_size = 3
The maximum number of CrawledUrls to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value.
message
web_security_scanner.proto:333Response for the `ListCrawledUrls` method.
repeated crawled_urls = 1
The list of CrawledUrls returned.
string next_page_token = 2
Token to retrieve the next page of results, or empty if there are no more results in the list.
Gets a Finding.
message
web_security_scanner.proto:343Request for the `GetFinding` method.
string name = 1
Required. The resource name of the Finding to be returned. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}/findings/{findingId}'.
List Findings under a given ScanRun.
message
web_security_scanner.proto:356Request for the `ListFindings` method.
string parent = 1
Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
string filter = 2
Required. The filter expression. The expression must be in the format: <field> <operator> <value>. Supported field: 'finding_type'. Supported operator: '='.
string page_token = 3
A token identifying a page of results to be returned. This should be a `next_page_token` value returned from a previous List request. If unspecified, the first page of results is returned.
int32 page_size = 4
The maximum number of Findings to return, can be limited by server. If not specified or not positive, the implementation will select a reasonable value.
message
web_security_scanner.proto:385Response for the `ListFindings` method.
repeated findings = 1
The list of Findings returned.
string next_page_token = 2
Token to retrieve the next page of results, or empty if there are no more results in the list.
List all FindingTypeStats under a given ScanRun.
message
web_security_scanner.proto:395Request for the `ListFindingTypeStats` method.
string parent = 1
Required. The parent resource name, which should be a scan run resource name in the format 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'.
message
web_security_scanner.proto:408Response for the `ListFindingTypeStats` method.
repeated finding_type_stats = 1
The list of FindingTypeStats returned.
message
crawled_url.proto:29A 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.
Used in:
string http_method = 1
The http method of the request that was used to visit the URL, in uppercase.
string url = 2
The URL that was crawled.
string body = 3
The body of the request that was used to visit the URL.
message
finding.proto:31A Finding resource represents a vulnerability instance identified during a ScanRun.
Used as response type in: WebSecurityScanner.GetFinding
Used as field type in:
string name = 1
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.
string finding_type = 2
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
string http_method = 3
The http method of the request that triggered the vulnerability, in uppercase.
string fuzzed_url = 4
The URL produced by the server-side fuzzer and used in the request that triggered the vulnerability.
string body = 5
The body of the request that triggered the vulnerability.
string description = 6
The description of the vulnerability.
string reproduction_url = 7
The URL containing human-readable payload that user can leverage to reproduce the vulnerability.
string frame_url = 8
If the vulnerability was originated from nested IFrame, the immediate parent IFrame is reported.
string final_url = 9
The URL where the browser lands when the vulnerability is detected.
string tracking_id = 10
The tracking ID uniquely identifies a vulnerability instance across multiple ScanRuns.
optional form = 16
An addon containing information reported for a vulnerability with an HTML form, if any.
optional outdated_library = 11
An addon containing information about outdated libraries.
optional violating_resource = 12
An addon containing detailed information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc.
optional vulnerable_headers = 15
An addon containing information about vulnerable or missing HTTP headers.
optional vulnerable_parameters = 13
An addon containing information about request parameters which were found to be vulnerable.
optional xss = 14
An addon containing information reported for an XSS, if any.
message
finding_type_stats.proto:28A FindingTypeStats resource represents stats regarding a specific FindingType of Findings under a given ScanRun.
Used in:
string finding_type = 1
The finding type associated with the stats.
int32 finding_count = 2
The count of findings belonging to this finding type.
message
finding_addon.proto:27! Information about a vulnerability with an HTML.
Used in:
string action_uri = 1
! The URI where to send the form when it's submitted.
repeated string fields = 2
! The names of form fields related to the vulnerability.
message
finding_addon.proto:36Information reported for an outdated library.
Used in:
string library_name = 1
The name of the outdated library.
string version = 2
The version number.
repeated string learn_more_urls = 3
URLs to learn more information about the vulnerabilities in the library.
message
scan_config.proto:32A ScanConfig resource contains the configurations to launch a scan.
Used as response type in: WebSecurityScanner.CreateScanConfig, WebSecurityScanner.GetScanConfig, WebSecurityScanner.UpdateScanConfig
Used as field type in: , ,
string name = 1
The resource name of the ScanConfig. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}'. The ScanConfig IDs are generated by the system.
string display_name = 2
Required. The user provided display name of the ScanConfig.
int32 max_qps = 3
The maximum QPS during scanning. A valid value ranges from 5 to 20 inclusively. If the field is unspecified or its value is set 0, server will default to 15. Other values outside of [5, 20] range will be rejected with INVALID_ARGUMENT error.
repeated string starting_urls = 4
Required. The starting URLs from which the scanner finds site pages.
optional authentication = 5
The authentication configuration. If specified, service will use the authentication configuration during scanning.
ScanConfig.UserAgent user_agent = 6
The user agent used during scanning.
repeated string blacklist_patterns = 7
The blacklist URL patterns as described in https://cloud.google.com/security-scanner/docs/excluded-urls
optional schedule = 8
The schedule of the ScanConfig.
repeated ScanConfig.TargetPlatform target_platforms = 9
Set of Cloud Platforms targeted by the scan. If empty, APP_ENGINE will be used as a default.
ScanConfig.ExportToSecurityCommandCenter export_to_security_command_center = 10
Controls export of scan configurations and results to Cloud Security Command Center.
optional latest_run = 11
Latest ScanRun if available.
ScanConfig.RiskLevel risk_level = 12
The risk level selected for the scan
message
scan_config.proto:39Scan authentication configuration.
Used in:
oneof authentication
Required. Authentication configuration
google_account = 1
Authentication using a Google account.
custom_account = 2
Authentication using a custom account.
message
scan_config.proto:54Describes authentication configuration that uses a custom account.
Used in:
string username = 1
Required. The user name of the custom account.
string password = 2
Required. Input only. The password of the custom account. The credential is stored encrypted and not returned in any response nor included in audit logs.
string login_url = 3
Required. The login form URL of the website.
message
scan_config.proto:41Describes authentication configuration that uses a Google account.
Used in:
string username = 1
Required. The user name of the Google account.
string password = 2
Required. Input only. The password of the Google account. The credential is stored encrypted and not returned in any response nor included in audit logs.
Controls export of scan configurations and results to Cloud Security Command Center.
Used in:
EXPORT_TO_SECURITY_COMMAND_CENTER_UNSPECIFIED = 0
Use default, which is ENABLED.
ENABLED = 1
Export results of this scan to Cloud Security Command Center.
DISABLED = 2
Do not export results of this scan to Cloud Security Command Center.
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.
Used in:
RISK_LEVEL_UNSPECIFIED = 0
Use default, which is NORMAL.
NORMAL = 1
Normal scanning (Recommended)
LOW = 2
Lower impact scanning
message
scan_config.proto:81Scan schedule configuration.
Used in:
optional schedule_time = 1
A timestamp indicates when the next run will be scheduled. The value is refreshed by the server after each run. If unspecified, it will default to current server time, which means the scan will be scheduled to start immediately.
int32 interval_duration_days = 2
Required. The duration of time between executions in days.
Cloud platforms supported by Cloud Web Security Scanner.
Used in:
TARGET_PLATFORM_UNSPECIFIED = 0
The target platform is unknown. Requests with this enum value will be rejected with INVALID_ARGUMENT error.
APP_ENGINE = 1
Google App Engine service.
COMPUTE = 2
Google Compute Engine service.
Type of user agents used for scanning.
Used in:
USER_AGENT_UNSPECIFIED = 0
The user agent is unknown. Service will default to CHROME_LINUX.
CHROME_LINUX = 1
Chrome on Linux. This is the service default if unspecified.
CHROME_ANDROID = 2
Chrome on Android.
SAFARI_IPHONE = 3
Safari on IPhone.
message
scan_config_error.proto:30Defines 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.
Used in:
ScanConfigError.Code code = 1
Indicates the reason code for a configuration failure.
string field_name = 2
Indicates the full name of the ScanConfig field that triggers this error, for example "scan_config.max_qps". This field is provided for troubleshooting purposes only and its actual value can change in the future.
Output only. Defines an error reason code. Next id: 44
Used in:
CODE_UNSPECIFIED = 0
There is no error.
OK = 0
There is no error.
INTERNAL_ERROR = 1
Indicates an internal server error. Please DO NOT USE THIS ERROR CODE unless the root cause is truly unknown.
APPENGINE_API_BACKEND_ERROR = 2
One of the seed URLs is an App Engine URL but we cannot validate the scan settings due to an App Engine API backend error.
APPENGINE_API_NOT_ACCESSIBLE = 3
One of the seed URLs is an App Engine URL but we cannot access the App Engine API to validate scan settings.
APPENGINE_DEFAULT_HOST_MISSING = 4
One of the seed URLs is an App Engine URL but the Default Host of the App Engine is not set.
CANNOT_USE_GOOGLE_COM_ACCOUNT = 6
Google corporate accounts can not be used for scanning.
CANNOT_USE_OWNER_ACCOUNT = 7
The account of the scan creator can not be used for scanning.
COMPUTE_API_BACKEND_ERROR = 8
This scan targets Compute Engine, but we cannot validate scan settings due to a Compute Engine API backend error.
COMPUTE_API_NOT_ACCESSIBLE = 9
This scan targets Compute Engine, but we cannot access the Compute Engine API to validate the scan settings.
CUSTOM_LOGIN_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT = 10
The Custom Login URL does not belong to the current project.
CUSTOM_LOGIN_URL_MALFORMED = 11
The Custom Login URL is malformed (can not be parsed).
CUSTOM_LOGIN_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS = 12
The Custom Login URL is mapped to a non-routable IP address in DNS.
CUSTOM_LOGIN_URL_MAPPED_TO_UNRESERVED_ADDRESS = 13
The Custom Login URL is mapped to an IP address which is not reserved for the current project.
CUSTOM_LOGIN_URL_HAS_NON_ROUTABLE_IP_ADDRESS = 14
The Custom Login URL has a non-routable IP address.
CUSTOM_LOGIN_URL_HAS_UNRESERVED_IP_ADDRESS = 15
The Custom Login URL has an IP address which is not reserved for the current project.
DUPLICATE_SCAN_NAME = 16
Another scan with the same name (case-sensitive) already exists.
INVALID_FIELD_VALUE = 18
A field is set to an invalid value.
FAILED_TO_AUTHENTICATE_TO_TARGET = 19
There was an error trying to authenticate to the scan target.
FINDING_TYPE_UNSPECIFIED = 20
Finding type value is not specified in the list findings request.
FORBIDDEN_TO_SCAN_COMPUTE = 21
Scan targets Compute Engine, yet current project was not whitelisted for Google Compute Engine Scanning Alpha access.
FORBIDDEN_UPDATE_TO_MANAGED_SCAN = 43
User tries to update managed scan
MALFORMED_FILTER = 22
The supplied filter is malformed. For example, it can not be parsed, does not have a filter type in expression, or the same filter type appears more than once.
MALFORMED_RESOURCE_NAME = 23
The supplied resource name is malformed (can not be parsed).
PROJECT_INACTIVE = 24
The current project is not in an active state.
REQUIRED_FIELD = 25
A required field is not set.
RESOURCE_NAME_INCONSISTENT = 26
Project id, scanconfig id, scanrun id, or finding id are not consistent with each other in resource name.
SCAN_ALREADY_RUNNING = 27
The scan being requested to start is already running.
SCAN_NOT_RUNNING = 28
The scan that was requested to be stopped is not running.
SEED_URL_DOES_NOT_BELONG_TO_CURRENT_PROJECT = 29
One of the seed URLs does not belong to the current project.
SEED_URL_MALFORMED = 30
One of the seed URLs is malformed (can not be parsed).
SEED_URL_MAPPED_TO_NON_ROUTABLE_ADDRESS = 31
One of the seed URLs is mapped to a non-routable IP address in DNS.
SEED_URL_MAPPED_TO_UNRESERVED_ADDRESS = 32
One of the seed URLs is mapped to an IP address which is not reserved for the current project.
SEED_URL_HAS_NON_ROUTABLE_IP_ADDRESS = 33
One of the seed URLs has on-routable IP address.
SEED_URL_HAS_UNRESERVED_IP_ADDRESS = 35
One of the seed URLs has an IP address that is not reserved for the current project.
SERVICE_ACCOUNT_NOT_CONFIGURED = 36
The Cloud Security Scanner service account is not configured under the project.
TOO_MANY_SCANS = 37
A project has reached the maximum number of scans.
UNABLE_TO_RESOLVE_PROJECT_INFO = 38
Resolving the details of the current project fails.
UNSUPPORTED_BLACKLIST_PATTERN_FORMAT = 39
One or more blacklist patterns were in the wrong format.
UNSUPPORTED_FILTER = 40
The supplied filter is not supported.
UNSUPPORTED_FINDING_TYPE = 41
The supplied finding type is not supported. For example, we do not provide findings of the given finding type.
UNSUPPORTED_URL_SCHEME = 42
The URL scheme of one or more of the supplied URLs is not supported.
message
scan_run.proto:33A ScanRun is a output-only resource representing an actual run of the scan. Next id: 12
Used as response type in: WebSecurityScanner.GetScanRun, WebSecurityScanner.StartScanRun, WebSecurityScanner.StopScanRun
Used as field type in: ,
string name = 1
The resource name of the ScanRun. The name follows the format of 'projects/{projectId}/scanConfigs/{scanConfigId}/scanRuns/{scanRunId}'. The ScanRun IDs are generated by the system.
ScanRun.ExecutionState execution_state = 2
The execution state of the ScanRun.
ScanRun.ResultState result_state = 3
The result state of the ScanRun. This field is only available after the execution state reaches "FINISHED".
optional start_time = 4
The time at which the ScanRun started.
optional end_time = 5
The time at which the ScanRun reached termination state - that the ScanRun is either finished or stopped by user.
int64 urls_crawled_count = 6
The number of URLs crawled during this ScanRun. If the scan is in progress, the value represents the number of URLs crawled up to now.
int64 urls_tested_count = 7
The number of URLs tested during this ScanRun. If the scan is in progress, the value represents the number of URLs tested up to now. The number of URLs tested is usually larger than the number URLS crawled because typically a crawled URL is tested with multiple test payloads.
bool has_vulnerabilities = 8
Whether the scan run has found any vulnerabilities.
int32 progress_percent = 9
The percentage of total completion ranging from 0 to 100. If the scan is in queue, the value is 0. If the scan is running, the value ranges from 0 to 100. If the scan is finished, the value is 100.
optional error_trace = 10
If result_state is an ERROR, this field provides the primary reason for scan's termination and more details, if such are available.
repeated warning_traces = 11
A list of warnings, if such are encountered during this scan run.
Types of ScanRun execution state.
Used in:
EXECUTION_STATE_UNSPECIFIED = 0
Represents an invalid state caused by internal server error. This value should never be returned.
QUEUED = 1
The scan is waiting in the queue.
SCANNING = 2
The scan is in progress.
FINISHED = 3
The scan is either finished or stopped by user.
Types of ScanRun result state.
Used in:
RESULT_STATE_UNSPECIFIED = 0
Default value. This value is returned when the ScanRun is not yet finished.
SUCCESS = 1
The scan finished without errors.
ERROR = 2
The scan finished with errors.
KILLED = 3
The scan was terminated by user.
message
scan_run_error_trace.proto:30Output only. Defines an error trace message for a ScanRun.
Used in:
ScanRunErrorTrace.Code code = 1
Indicates the error reason code.
optional scan_config_error = 2
If the scan encounters SCAN_CONFIG_ISSUE error, this field has the error message encountered during scan configuration validation that is performed before each scan run.
int32 most_common_http_error_code = 3
If the scan encounters TOO_MANY_HTTP_ERRORS, this field indicates the most common HTTP error code, if such is available. For example, if this code is 404, the scan has encountered too many NOT_FOUND responses.
Output only. Defines an error reason code. Next id: 7
Used in:
CODE_UNSPECIFIED = 0
Default value is never used.
INTERNAL_ERROR = 1
Indicates that the scan run failed due to an internal server error.
SCAN_CONFIG_ISSUE = 2
Indicates a scan configuration error, usually due to outdated ScanConfig settings, such as starting_urls or the DNS configuration.
AUTHENTICATION_CONFIG_ISSUE = 3
Indicates an authentication error, usually due to outdated ScanConfig authentication settings.
TIMED_OUT_WHILE_SCANNING = 4
Indicates a scan operation timeout, usually caused by a very large site.
TOO_MANY_REDIRECTS = 5
Indicates that a scan encountered excessive redirects, either to authentication or some other page outside of the scan scope.
TOO_MANY_HTTP_ERRORS = 6
Indicates that a scan encountered numerous errors from the web site pages. When available, most_common_http_error_code field indicates the most common HTTP error code encountered during the scan.
message
scan_run_warning_trace.proto:29Output only. Defines a warning trace message for ScanRun. Warning traces provide customers with useful information that helps make the scanning process more effective.
Used in:
ScanRunWarningTrace.Code code = 1
Indicates the warning code.
Output only. Defines a warning message code. Next id: 6
Used in:
CODE_UNSPECIFIED = 0
Default value is never used.
INSUFFICIENT_CRAWL_RESULTS = 1
Indicates that a scan discovered an unexpectedly low number of URLs. This is sometimes caused by complex navigation features or by using a single URL for numerous pages.
TOO_MANY_CRAWL_RESULTS = 2
Indicates that a scan discovered too many URLs to test, or excessive redundant URLs.
TOO_MANY_FUZZ_TASKS = 3
Indicates that too many tests have been generated for the scan. Customer should try reducing the number of starting URLs, increasing the QPS rate, or narrowing down the scope of the scan using the excluded patterns.
BLOCKED_BY_IAP = 4
Indicates that a scan is blocked by IAP.
message
finding_addon.proto:49Information regarding any resource causing the vulnerability such as JavaScript sources, image, audio files, etc.
Used in:
string content_type = 1
The MIME type of this resource.
string resource_url = 2
URL of this violating resource.
message
finding_addon.proto:64Information about vulnerable or missing HTTP Headers.
Used in:
repeated headers = 1
List of vulnerable headers.
repeated missing_headers = 2
List of missing headers.
message
finding_addon.proto:66Describes a HTTP Header.
Used in:
string name = 1
Header name.
string value = 2
Header value.
message
finding_addon.proto:58Information about vulnerable request parameters.
Used in:
repeated string parameter_names = 1
The vulnerable parameter names.
message
finding_addon.proto:82Information reported for an XSS.
Used in:
repeated string stack_traces = 1
Stack traces leading to the point where the XSS occurred.
string error_message = 2
An error message generated by a javascript breakage.