> For the complete documentation index, see [llms.txt](https://developer.harness.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.harness.io/security-testing-orchestration/3.0/use-sto/sto-scanner-configuration/wiz/artifact-scans-with-wiz.md).

# Artifact scans with Wiz

Scan artifacts with Wiz. Orchestration and Ingestion modes supported.

You can easily set up a Wiz step to run automated scans in a Harness pipeline. This step scans the container image you specify using the Wiz CLI. Then it correlates, deduplicates, and ingests the scan results into STO. You can see your scan results in the [Vulnerabilities](/security-testing-orchestration/3.0/use-sto/sto-security-issues/view-scan-results.md) tab of the pipeline execution.

{% hint style="info" %}
**Wiz CLI Upgrade Notice**

The Wiz CLI will be upgraded from version `0.x` to `1.x`. Harness STO supports this upgrade transparently, and no pipeline changes are required. CLI version `0.x` will continue to work with existing credentials, while CLI version `1.x` requires new credentials. Credentials used with CLI `0.x` are not supported in CLI `v1.x`.
{% endhint %}

### Important notes for running Wiz scans in STO <a href="#important-notes-for-running-wiz-scans-in-sto" id="important-notes-for-running-wiz-scans-in-sto"></a>

* You can set up your STO scan images and pipelines to run scans as non-root and establish trust for your proxies using custom certificates. For more information, go to [Configure your pipeline to use STO images from private registry](/security-testing-orchestration/3.0/troubleshooting-and-resources/sto-use-cases/set-up-sto-pipelines/configure-pipeline-to-use-sto-images-from-private-registry.md).
* If you use Wiz for Gov or GovCloud on Linux/macOS, configure `WIZ_ENV` environment variable in your wiz stage settings.
  * For `app.wiz.us` (Wiz for Gov, FedRAMP), set `WIZ_ENV=fedramp`.
  * For `gov.wiz.io` (GovCloud), set `WIZ_ENV=gov`.

### Set-up workflows <a href="#set-up-workflows" id="set-up-workflows"></a>

<details>

<summary>Orchestration scans for artifacts</summary>

The setup process for Kubernetes and Docker build infrastructures has a few additional steps and requirements.

PrerequisitesA Kubernetes or Docker build infrastructureHarness text secrets if your image registry requires an access ID and access tokenHarness text secrets for your client-id and client-secret to authenticate with the Wiz CLIAdd a Docker-in-Docker background stepThis is required for orchestrated image scans on Kubernetes or Docker build infrastructures.Add the Wiz scannerDo the following:Add a CI Build or Security stage to your pipeline.Add a Wiz step to the stage.Set up the Wiz scannerRequired settingsScan mode = OrchestrationTarget type = Container imageTarget and Variant Detection = AutoContainer image:TypeDomain — Required only if you're using a registry with a non-standard domain, such as a private registry.Name — for example, jsmith/myimageTag — for example, latestAuthentication — Required only if the registry requires authentication:Registry access Id as a Harness secretRegistry access token as a Harness secretAuthentication:Wiz access ID as a Harness secret. This is your client-id to authenticate with the Wiz CLI.Wiz access token as a Harness secret. This is your client-secret to authenticate with the Wiz CLI.Optional settingsFail on Severity — Stop the pipeline if the scan detects any issues at a specified severity or higherLog Level — Useful for debuggingPrerequisitesHarness text secrets if your image registry requires an access Id and access tokenHarness text secrets for your client-id and client-secret to authenticate with the Wiz CLIAdd the Wiz scannerDo the following:Add a Build or Security stage to your pipeline.Add a Wiz step to the stage.Set up the Wiz scannerRequired settingsScan mode = OrchestrationTarget type = Container imageTarget and Variant Detection = AutoContainer image:TypeDomain — Required only if you're using a registry with a non-standard domain, such as a private registryName — for example, jsmith/myimageTag — for example, latestAuthentication — Required only if the registry requires authentication:Registry access Id as a Harness secretRegistry access token as a Harness secretAuthentication:Wiz access ID as a Harness secret. This is your client-id to authenticate with the Wiz CLI.Wiz access token as a Harness secret. This is your client-secret to authenticate with the Wiz CLI.Optional settingsFail on Severity — Stop the pipeline if the scan detects any issues at a specified severity or higher.Log Level — Useful for debugging.

</details>

<details>

<summary>Ingestion scans for artifacts</summary>

{% hint style="info" %}
Harness STO can ingest both JSON and SARIF data from Wiz, but Harness recommends publishing to JSON because this format includes more detailed information.
{% endhint %}

**Add a shared path for your scan results**

1. Add a Build or Security stage to your pipeline.
2. In the stage **Overview**, add a shared path such as `/shared/scan_results`.

**Copy scan results to the shared path**

There are two primary workflows to do this:

* Add a Run step that runs a Wiz scan from the command line and then copies the results to the shared path.
* Copy results from a Wiz scan that ran outside the pipeline.

For more information and examples, go to [Ingestion scans](/security-testing-orchestration/3.0/new-to-sto/key-concepts/ingest-scan-results-into-an-sto-pipeline.md).

**Set up the Wiz scanner**

Add a Wiz step to the stage and set it up as follows.

**Required settings**

1. [Scan mode](#scan-mode) = **Ingestion**
2. [Target type](#type) = **Container Image**
3. [Target name](#name) — Usually the image name, such as `jsmith/myimage`
4. [Target variant](#name) — Usually the image tag, such as `latest`. You can also use a [runtime input](/harness-platform/3.0/harness-platform-resources/variables-and-expressions/runtime-input-usage.md) and specify the tag at runtime.
5. [Ingestion file](#ingestion-file) — For example, `/shared/scan_results/wiz-scan.json`

**Optional settings**

* [Fail on Severity](#fail-on-severity) — Stop the pipeline if the scan detects any issues at a specified severity or higher
* [Log Level](#log-level) — Useful for debugging

</details>

### Wiz step settings reference <a href="#wiz-step-settings-reference" id="wiz-step-settings-reference"></a>

The recommended workflow is to add a Wiz step to a Security Tests or CI Build stage and then configure it as described below.

#### Scan <a href="#scan" id="scan"></a>

**Scan Mode**

#### Target <a href="#target" id="target"></a>

**Type**

**Target and Variant Detection**

**Name**

The identifier for the [target](/security-testing-orchestration/3.0/new-to-sto/key-concepts/targets-and-baselines.md) such `jsmith/myalphaservice`. Descriptive target names make it much easier to navigate your scan data in the STO UI.

It is good practice to [specify a baseline](/security-testing-orchestration/3.0/new-to-sto/key-concepts/targets-and-baselines.md#every-target-needs-a-baseline) for every target.

**Variant**

**Workspace**

#### Container image <a href="#container-image" id="container-image"></a>

**Type**

**Domain**

**Name**

**Tag/Digest**

**Access ID**

**Access Token**

#### Ingestion File <a href="#ingestion-file" id="ingestion-file"></a>

The path to your scan results when running an [Ingestion scan](/security-testing-orchestration/3.0/new-to-sto/key-concepts/ingest-scan-results-into-an-sto-pipeline.md), for example `/shared/scan_results/wiz.latest.json`.

* The data file must be in a [supported format](/security-testing-orchestration/3.0/new-to-sto/sto-whats-supported/scanners.md#supported-ingestion-formats) for the scanner.
* The data file must be accessible to the scan step. It's good practice to save your results files to a [shared path](/continuous-integration/3.0/new-to-harness-ci/key-concepts.md#stages) in your stage. In the visual editor, go to the stage where you're running the scan. Then go to **Overview** > **Shared Paths**. You can also add the path to the YAML stage definition like this:

  ```yaml
      - stage:
        spec:
          sharedPaths:
            - /shared/scan_results
  ```

#### Authentication <a href="#authentication" id="authentication"></a>

**Access ID**

This is your `client-id` to authenticate with the Wiz CLI.

**Access Token**

This is your `client-secret` to authenticate with the Wiz CLI.

You should create a Harness text secret with your encrypted token and reference the secret using the format `<+secrets.getValue("my-access-token")>`. For more information, go to [Add and Reference Text Secrets](/harness-platform/3.0/harness-platform-resources/secrets/add-use-text-secrets.md).

#### Log Level <a href="#log-level" id="log-level"></a>

#### Additional CLI flags <a href="#additional-cli-flags" id="additional-cli-flags"></a>

{% hint style="warning" %}
Passing CLI flags is an advanced feature. Some flags might not work in the context of STO. You should test your flags and arguments thoroughly before you use them in your production environment.
{% endhint %}

#### Fail on Severity <a href="#fail-on-severity" id="fail-on-severity"></a>

#### Settings <a href="#settings" id="settings"></a>

You can add more settings to the scan step as needed.

#### Additional Configuration <a href="#additional-configuration" id="additional-configuration"></a>

#### Advanced settings <a href="#advanced-settings" id="advanced-settings"></a>

### View Wiz policy failures <a href="#view-wiz-policy-failures" id="view-wiz-policy-failures"></a>

### Proxy settings <a href="#proxy-settings" id="proxy-settings"></a>

{% @harness-feedback/feedback %}