> [!NOTE]
> Standard-legacy, Premium, and Enterprise (Deprecated) [service tiers](https://docs.cloud.google.com/security-command-center/docs/service-tiers.md.txt)

> [!CAUTION]
> The Security Command Center Enterprise service tier will shut down on May 21, 2027. If your organization uses the Enterprise service tier, then the organization will automatically move to the Premium service tier on or after May 21, 2027. Contact your account representative or a [Google Cloud sales specialist](https://cloud.google.com/contact) if you have questions.

Schedule and run custom scans on a deployed application using
Web Security Scanner in the Google Cloud console. Web Security Scanner supports scans
for public URLs and IPs that aren't behind a firewall.

> [!IMPORTANT]
> **Important:** The managed scans that are included with the Security Command Center Premium tier are separate from Web Security Scanner custom scans. Custom scans are more thorough than default managed scans and provide granular information about application vulnerability findings. This page provides more information about custom scans.

## Before you begin

To set up custom scans using Web Security Scanner:

- You must have a deployed application on a public URL or IP. Web Security Scanner only supports websites using IPv4. Websites using IPv6 are not scanned.
- You must have Security Command Center enabled.

Before you scan, carefully audit your application for any feature that may
affect data, users, or systems beyond the chosen scope of your scan.

Because Web Security Scanner populates fields, pushes buttons, clicks links, and
other interaction, you should use it with caution. Web Security Scanner might
activate features that change the state of your data or system, with undesirable
results. For example:

- In a blog application that allows public comments, Web Security Scanner might post test strings as comments on all your blog articles.
- In an email sign-up page, Web Security Scanner might generate large numbers of test emails.

For tips about how to minimize risk, see [best practices](https://docs.cloud.google.com/security-command-center/docs/concepts-web-security-scanner-overview.md.txt#best_practices) to prevent unintended
consequences.

## Enable Web Security Scanner

Enable Web Security Scanner in Security Command Center to create and run custom
scans.

If [Security Command Center is active](https://docs.cloud.google.com/security-command-center/docs/activate-scc-overview.md.txt), you
can enable Web Security Scanner in the Google Cloud console on the
Security Command Center
[**Settings** page](https://console.cloud.google.com/security/command-center/config/services)

### Step 1: Deploying a test application

To complete Web Security Scanner setup for custom scans, you need the URL of a
Compute Engine, Google Kubernetes Engine (GKE), or App Engine application
that is already deployed. If you don't have a deployed application, or if you
want to try out Web Security Scanner with a test application, deploy the test
App Engine application. Use the language of your choice:

- [Java](https://docs.cloud.google.com/appengine/docs/java.md.txt)
- [Python](https://docs.cloud.google.com/appengine/docs/python.md.txt)
- [Go](https://docs.cloud.google.com/appengine/docs/go.md.txt)
- [PHP](https://docs.cloud.google.com/appengine/docs/php.md.txt)

### Step 2: Assign IAM roles

To run a Web Security Scanner scan, you must have one of the following
Identity and Access Management (IAM) roles for the project you want to scan:

- Editor
- Owner

To add one of these roles:

1. Go to the [IAM \& Admin](https://console.cloud.google.com/iam-admin/iam) page in the
   Google Cloud console.


   [Go to the IAM \& Admin page](https://console.cloud.google.com/iam-admin/iam)

   <br />

2. Click the **Project selector** drop-down list.

3. On the **Select from** dialog that appears, select the project that you want
   to scan using Web Security Scanner.

4. On the **IAM** page, next to your username, click **Edit**.

5. On the **Edit permissions** panel that appears, click **Add another role**,
   and then select one of the following roles:

   - **Project** \> **Owner**
   - **Project** \> **Editor**
6. When you're finished adding roles, click **Save**.

Learn more about
[Web Security Scanner roles](https://docs.cloud.google.com/security-command-center/docs/access-control.md.txt).

### Step 3: Run a scan

When you set up a scan, it's queued to run later. Depending on current load, it
might be several hours before a scan executes. To create, save, and run a scan:

1. Go to the **Web Security Scanner** page in the Google Cloud console.


   [Go to Web Security Scanner](https://console.cloud.google.com/security/web-scanner)

   <br />

2. Select the project that contains the deployed application you want to scan.

3. To set up a new scan, click **New scan**:

4. On the **Create a new scan** page that loads, set the following values:

   1. Under **Starting URLs**, enter the URL of the application you want to scan.
   2. Under **Schedule** , select **Weekly**.
   3. Under **Next run on**, select a date.

   The box to **Export to Security Command Center** is automatically checked. If you've
   enabled Web Security Scanner as a Security Command Center
   [security source](https://docs.cloud.google.com/security-command-center/docs/concepts-security-sources.md.txt), scan results
   appear on the **Findings** page in the Google Cloud console.

   For this first scan, use the default scan without changing any other values
   on the **Create a new scan** page. For more information about scan settings,
   see [Scanning an app](https://docs.cloud.google.com/security-command-center/docs/how-to-web-security-scanner-custom-scans.md.txt#scan-app).
5. To create the scan, click **Save**.

6. On the Web Security Scanner page, click the scan name to load its overview
   page, and then click **Run scan**.

   The scan will be queued, and then it will run at a future time.
   *It might take several hours before the scan runs.*
7. The scan overview page displays a results section when the scan completes.
   The following image shows example scan results when no vulnerabilities are
   detected:

   ![](https://docs.cloud.google.com/security-command-center/images/scan-result.png)

   If you've enabled Web Security Scanner as a Web Security Scanner
   [security source](https://docs.cloud.google.com/security-command-center/docs/quickstart-scc-setup#add-security-sources),
   scan results are also displayed on the Google Cloud console.

   To display details about a specific finding, click the finding name in
   the scan results.

You have now completed a basic Web Security Scanner scan. If you scanned your
own application, learn how to customize the scan in the
[scanning an app](https://docs.cloud.google.com/security-command-center/docs/how-to-web-security-scanner-custom-scans.md.txt#scan-app) section on this page.

If you deployed a test application to run the scan, complete the following
[clean up](https://docs.cloud.google.com/security-command-center/docs/how-to-web-security-scanner-custom-scans.md.txt#clean-up) step on this page to avoid incurring App Engine
charges for the application.

### Step 4: Cleaning up

> [!CAUTION]
> **Caution** : Deleting a project has the following effects:
>
> - **Everything in the project is deleted.** If you used an existing project for the tasks in this document, when you delete it, you also delete any other work you've done in the project.
> - **Custom project IDs are lost.** When you created this project, you might have created a custom project ID that you want to use in the future. To preserve the URLs that use the project ID, such as an `appspot.com` URL, delete selected resources inside the project instead of deleting the whole project.

1. In the Google Cloud console, go to the **Manage resources** page.

   [Go to Manage resources](https://console.cloud.google.com/iam-admin/projects)
2. In the project list, select the project that you want to delete, and then click **Delete**.
3. In the dialog, type the project ID, and then click **Shut down** to delete the project.

<br />

## Scanning an app

Set up a custom scan for your app using a test account.

### Step 1: Creating a test account

When you scan your app, it's best to use a test account that doesn't have access
to sensitive data or harmful operations. Create a test account that can sign in
to your app. Note the login credentials to provide for authentication when
creating a scan. The credentials enable you to use the test account to scan
data.

### Step 2: Creating a scan

1. Go to the **Web Security Scanner** page in the Google Cloud console.


   [Go to Web Security Scanner](https://console.cloud.google.com/security/web-scanner)

   <br />

2. Click **Select**, and then select a project that already has an
   App Engine, Compute Engine, or GKE
   application deployed.

3. To display the new scan form, click **Create scan** or **New scan**.

4. To add values to the new scan form, use the following table as a guide:

   | Field | Description |
   |---|---|
   | Starting URLs | A basic site usually requires only one starting URL, like the home, main, or landing page for the site, from which Web Security Scanner can find all other site pages. However, Web Security Scanner might not find all pages if a site has: - Many pages - Islands of unconnected pages - Navigation that requires complex JavaScript like a mouseover-driven multilevel menu In such cases, specify more starting URLs to increase scan coverage. |
   | Excluded URLs | To reduce complexity, exclusions are defined using a simplified proto-language using one or more \* wildcards, instead of requiring a valid regular expression. For details and sample valid patterns, see [Excluding URLs](https://docs.cloud.google.com/security-command-center/docs/how-to-web-security-scanner-custom-scans.md.txt#excluding_urls) later on this page. |
   | Authentication \> Google Account | You can create a test account in Gmail and then use the account to scan your product. If you are a Google Workspace customer, you can create test accounts within your domain, for example, `test-account@yourdomain.com`. In Web Security Scanner, these accounts work like Gmail accounts. Two factor authentication is not supported. Google enforces a real name policy on Google Accounts. If the name on your test account doesn't look real, the account might be blocked. |
   | Authentication \> Identity-Aware Proxy alpha | To protect resources with Identity-Aware Proxy, see the [IAP guide](https://docs.cloud.google.com/iap/docs/how-to.md.txt). To use Web Security Scanner with an IAP-protected resource, first grant access to the Web Security Scanner service account: 1. Go to the [IAP page](https://console.cloud.google.com/projectselector2/security/iap/) in the Google Cloud console. 2. Select the project that you want to use with Web Security Scanner. 3. Select the application resource you want to scan, and then click **Add Principal** on the **Info Panel**. 4. In the **New principals** box on the **Add principals** panel, enter the Web Security Scanner service account in the form of `service-project-number@gcp-sa-websecurityscanner.iam.gserviceaccount.com`. 5. On the **Select a role** drop-down list, select **Cloud IAP \> IAP Secured Web App User**. 6. When you're finished adding roles, click **Save**. Next, add the OAuth client ID to the scan. Web Security Scanner can only scan applications that are protected by a single OAuth Client ID. To add the OAuth client ID: 1. Go to the [IAP page](https://console.cloud.google.com/projectselector2/security/iap/) in the Google Cloud console. 2. Select the project that you want to use with Web Security Scanner. 3. On the **Overflow menu** , select **Edit OAuth Client**. 4. On the **Client ID for web application** window that appears, copy the **Client ID**. 5. Go to the [Web Security Scanner page](https://console.cloud.google.com/projectselector2/security/web-scanner/scanConfigs/) in the Google Cloud console. 6. Under **Authentication** , select **Identity-Aware Proxy alpha**. 7. In the **OAuth2 Client ID** box, paste the OAuth client ID that you copied, and then click **Save**. |
   | Authentication \> Non-Google account | Select this option if you have created your own authentication system and you aren't using Google Account services. Specify the login form's URL, the username, and the password. These credentials are used to sign in to your application and scan it. Web Security Scanner attempts heuristics to sign in to your application, and scan it. Specifically, this method looks for a two field login-form that includes a `username` field and `password` field. The login action must result in an authentication cookie for the scanner to continue its scan. Common issues can cause custom login to fail include: - Using non-standard HTML form fields, for example, not using a `password` type. - Using a complicated login form, for example, a form that has more than a single `username` and `password` field. - Not saving an authentication cookie on successful login. - In some situations, the scanner is denied by counter-measures that are meant to protect against bots, DDOS, and other attacks. We recommend using Identity-Aware Proxy integration for the most consistent experience with authenticated scanning of applications. |
   | Schedule | You can set the scan to run daily, weekly, every two weeks, or every four weeks. It's best to create a scheduled scan to ensure that future versions of your application are tested. Also, because we occasionally release new scanners that find new bug types, running a scheduled scan offers more coverage without manual effort. |
   | Run scans from a predefined set of source IPs ([Preview](https://cloud.google.com/products/#product-launch-stages)) | Select this option to restrict scan traffic to a predefined set of IP addresses. This lets you enable the scanner to access applications behind a firewall, but may limit the scope of the scan. To modify your firewall rules to allow Web Security Scanner traffic, see [Configuring the firewall](https://docs.cloud.google.com/security-command-center/docs/how-to-web-security-scanner-custom-scans.md.txt#firewall-configuration) later on this page. |
   | Export options | Select this option to automatically export scan configurations and scan results to Security Command Center. |
   | Ignore HTTP status errors | This option controls whether a high number of HTTP status errors---for example, \*\*400 Bad Request\*\*---during a scan will cause the scan to be reported as a failure. If the option is selected, status errors are ignored. If the option is not selected, and the percentage of status errors exceeds a predetermined threshold, the scan is reported as a failure. |

5. When you're finished adding values, click **Save**. You can now run the new
   scan.

By default, Web Security Scanner uses randomly assigned IP addresses during
each run. To make Web Security Scanner IP addresses predictable, complete
the steps to [enable scans from static IPs](https://docs.cloud.google.com/security-command-center/docs/how-to-web-security-scanner-custom-scans.md.txt#static-ip) later on this page.

### Step 3: Running a scan

To run a scan:

1. Sign in to the test account that you used to create the scan.
2. Go to the **Web Security Scanner** page in the Google Cloud console.


   [Go to Web Security Scanner](https://console.cloud.google.com/security/web-scanner)

   <br />

3. Click **Select**, and then select the project that you created the scan in.

4. Under **Scan configs**, click the name of the scan that you want to run.

5. On the scan details page, click **Run**.

The scan is placed in a queue, and there might be a delay before it runs. It can
take several minutes or many hours to run, depending on the system load and
features like:

- Site complexity
- Number of actionable elements per page
- Number of links
- The amount of JavaScript on the site, including navigation

You can set up and run up to 10 different scans before you need to delete or
clean up previously saved results.

## Viewing custom scan results

The status and results of a custom scan are displayed on the scan details page
in the Google Cloud console. To view scan results:

1. Sign in to the test account that you used to create the scan.
2. Go to the **Web Security Scanner** page in the Google Cloud console.


   [Go to Web Security Scanner](https://console.cloud.google.com/security/web-scanner)

   <br />

3. Click **Select**, and then select the project that contains the scan that
   you want to review.

4. Under **Scan configs**, click the name of the scan that you want to review.

The scan details page loads and displays results from the most recent scan. If a
scan is in progress, the **Results** tab displays the current completion
percent. To display results from previous scans, select the scan date and time
from the drop-down list.

Details for completed custom scans include:

- The **Results** tab displays a list of vulnerabilities the scan found, if any.
- The **URLs crawled** tab displays a list of URLs that the scan checked.
- The **Details** tab includes:

  - Starting URLs
  - Authentication
  - User agent
  - Maximum scan speed as queries per second (QPS)

You can find more information about the scan in the project
[logs page](https://console.cloud.google.com/project/_/logs).

## Editing a custom scan

To edit a custom scan:

1. Sign in to the test account that you used to create the scan.
2. Go to the **Web Security Scanner** page in the Google Cloud console.


   [Go to Web Security Scanner](https://console.cloud.google.com/security/web-scanner)

   <br />

3. Click **Select**, and then select the project that contains the scan that
   you want to edit.

4. Under **Scan configs**, click the name of the scan that you want to edit.

5. On the scan details page that appears, click **Edit**.

6. On the **Editing \[scan name\]** page that appears, make changes that you
   want, and then click **Save**.

The edited custom scan runs when it's next scheduled, or you can manually run it
to get updated results.

## Deleting a custom scan

To delete one or more custom scans:

1. Sign in to the test account that you used to create the scan.
2. Go to the **Web Security Scanner** page in the Google Cloud console.


   [Go to Web Security Scanner](https://console.cloud.google.com/security/web-scanner)

   <br />

3. Click **Select**, and then select the project that contains the scan that
   you want to edit.

4. Under **Scan configs**, select the checkbox next to one or more scans that
   you want to delete.

5. Click **Delete** , and then click **Ok**.

All scans that you selected are deleted.

## Setting up a scan from static IPs

> [!NOTE]
>
>
> This feature is
>
> subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the
> [Service Specific
> Terms](https://docs.cloud.google.com/terms/service-terms#1).
>
> Pre-GA features are available "as is" and might have limited support.
>
> For more information, see the
> [launch stage descriptions](https://cloud.google.com/products/#product-launch-stages).

This section describes how to enable Web Security Scanner custom scans from
static IP addresses. When you enable this feature, Web Security Scanner uses
predictable IP addresses to scan your public Compute Engine and Google Kubernetes Engine
applications. This feature is in Preview, and the Web Security Scanner IP
addresses might change in a future release.

### Before you begin

To use the Web Security Scanner custom scans from static IPs feature, you
need:

- A public Compute Engine or GKE application. This feature doesn't support App Engine applications.
- A scan created with no authentication, or with Google Account authentication. This feature doesn't support scans that use non-Google account authentication.

### Step 1: Configuring the firewall

1. Go to the Firewall rules page in the Google Cloud console.


   [Go to Firewall rules](https://console.cloud.google.com/projectselector2/networking/firewalls)

   <br />

2. Click **Select**, and then select your project.

3. On the **Firewall rules** page that appears, click **Create Firewall Rule**.

4. On the **Create a firewall rule** page, set the following values:

   1. **Name** : enter `web-security-scanner` or a similar name.
   2. **Priority**: select a higher priority (lower number value) than all of the rules that deny egress traffic to your application.
   3. **Source IP ranges** : enter `34.66.18.0/26` and `34.66.114.64/26`.
   4. **Protocols and ports** : select **Allow all** or specify the protocols and ports for your application. Usually, you can select the **tcp** checkbox and then enter `80` and `443` for the ports.
5. When you're finished setting values, click **Create**.

### Step 2: Configuring the scan

After you configure your firewall to allow the Web Security Scanner
predictable IP addresses, configure the scan to use predefined IPs:

1. Go to the **Web Security Scanner** page in the Google Cloud console.


   [Go to Web Security Scanner](https://console.cloud.google.com/projectselector2/security/web-scanner/)

   <br />

2. Click **Select**, and then select your project.

3. Create a new scan or edit an existing scan.

4. Select the **Run scans from a pre-defined set of source IPs** checkbox.

5. Save the scan.

The next time the scan runs, it will scan the public Compute Engine and
GKE applications that are behind the firewall.

## Excluding URLs

You can specify up to 100 excluded URL patterns to avoid testing sections of a
site during a custom scan. Web Security Scanner doesn't request resources that
match any of the exclusions. The following sections describe the pattern
matching that Web Security Scanner uses.

> [!NOTE]
> **Note:** A high number of excluded URL patterns can slow down your scans. Also, specifying more than 100 excluded URL patterns can cause Web Security Scanner custom scans to fail.

### URL pattern matching

Excluded URL matching is based on a set of URLs defined by match patterns. A
match pattern is a URL with five segments:

- `scheme`: for example, `http` or `*`
- `host`: for example, `www.google.com` or `*.google.com` or `*`
- `path`: for example, `/*`, `/foo*`, or `/foo/bar. *`
- `query`: for example, `?*`, `?*foo=bar*`
- `fragment`: for example, `#*`, `#access`

Following is the basic syntax:

    <exclude-pattern> := <scheme>://<host><path><query><fragment>
    <scheme> := '*' | 'http' | 'https'
    <host> := '*' | '*.' <any char except '/' and '*'>+
    <path> := '/' <any chars except '?' or '#'>
    <query> := '?' <any chars except '#'>
    <fragment> := '#' <any chars>

The `*` in each part has the following function:

- `scheme`: `*` matches either HTTP or HTTPS.
- `host`:

  - `*` matches any host
  - `*.hostname` matches the specified host and any of its subdomains.
- `path`: `*` matches 0 or more characters.

All segments are not required in an excluded pattern.

- If the `scheme` segment is not specified, it defaults to `*://`.
- The `host` segment must always be specified.
- If the `path` segment is not specified, it defaults to:

  - `/*`, if `query` and `fragment` segments are not specified. This value matches any `path` or no `path`.
  - `/`, or an empty `path`, if either the`query` or `fragment` segment is specified.
- If the `query` segment is not specified, it defaults to:

  - `?*`, if the `fragment` segment is not specified. This value matches any `query` or no `query`.
  - `?`, or an empty `query`, if the `fragment` is specified.
- If the `fragment` segment is not specified, it defaults to `#*`, which matches
  any `fragment` or no `fragment`.

#### Valid Pattern Matches

The following table provides examples of valid patterns:

| Pattern | Behavior | Sample matching URLs |
|---|---|---|
| `http://*/*` | Matches any URL that uses the HTTP scheme. | `http://www.google.com/` `http://example.org/foo/bar.html` |
| `http://*/foo*` | Matches any URL that uses the HTTP scheme, on any host, if the path starts with `/foo`. | `http://example.com/foo/bar.html` `http://www.google.com/foo` |
| `https://*.google.com/foo*bar` | Matches any URL that uses the HTTPS scheme and is on a `google.com` host --- like `www.google.com`, `docs.google.com`, or `google.com` --- if the path starts with `/foo` and ends with `bar`. | `http://www.google.com/foo/baz/bar` `http://docs.google.com/foobar` |
| `http://example.org/foo/bar.html` | Matches the specified URL. | `http://example.org/foo/bar.html` |
| `http://127.0.0.1/*` | Matches any URL that uses the HTTP scheme and is on the host `127.0.0.1`. | `http://127.0.0.1/` `http://127.0.0.1/foo/bar.html` |
| `*://mail.google.com/*` | Matches any URL that starts with `http://mail.google.com` or `https://mail.google.com`. | `http://mail.google.com/foo/baz/bar` `https://mail.google.com/foobar` |
| `*://*/foo*?*bar=baz*` | Matches any URL where the path starts with `/foo` and has the query parameter `bar=baz`. | `https://www.google.com/foo/example?bar=baz` |
| `google.com/app#*open*` | Matches any URL with a `google.com` host where the path starts with `/app` and has the fragment `open`. | `https://www.google.com/app/example#open` |

#### Invalid pattern matches

The following table provides examples of invalid patterns:

| Pattern | Reason |
|---|---|
| `http://www.google.com` | The URL doesn't include a path. |
| `http://*foo/bar` | `*` in the host must be followed by a `.` or `/`. |
| `http://foo.*.bar/baz` | If `*` is in the host, it must be the first character. |
| `http:/bar` | The URL is scheme separator isn't properly formed. The `"/"` should be `"//"`. |
| `foo://*` | The URL scheme is invalid. |

## What's next

- Learn how to [remediate Web Security Scanner findings](https://docs.cloud.google.com/security-command-center/docs/how-to-remediate-web-security-scanner-findings.md.txt).