> 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/continuous-delivery/use-continuous-delivery/cd-building-blocks/cd-steps/containerized-steps/wiz-artifact-scan.md).

# Artifact scans with Wiz

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/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/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`.

<figure><img src="/files/UNcF7DEHw21PjVaUahxj" alt="Configure WIZ_ENV in stage settings for Wiz for Gov and GovCloud"><figcaption><p>Click to view full size</p></figcaption></figure>

### 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.

Prerequisites- A \[Kubernetes]\(#/docs/continuous-integration/use-ci/set-up-build-infrastructure/k8s-build-infrastructure/set-up-a-kubernetes-cluster-build-infrastructure/) or \[Docker]\(<https://app.gitbook.com/s/qKtVmwAGTfGQS1MVC97G/use-harness-ci/use-harness-ci/set-up-build-infrastructure/define-a-docker-build-infrastructure>) build infrastructure- \[Harness text secrets]\(<https://app.gitbook.com/s/3F2TpHXhur2QtQnORSM9/use-harness-platform/secrets/add-use-text-secrets>) if your image registry requires an access ID and access token- \[Harness text secrets]\(<https://app.gitbook.com/s/3F2TpHXhur2QtQnORSM9/use-harness-platform/secrets/add-use-text-secrets>) for your \`client-id\` and \`client-secret\` to authenticate with the Wiz CLI Add a Docker-in-Docker background stepThis is required for orchestrated image scans on Kubernetes or Docker build infrastructures.\<div data-gb-custom-block data-tag="include" data-0='../../../.gitbook/includes/\_\_shared/sto-techref-category/shared/dind-bg-step-setup.md'>\</div>Add the Wiz scannerDo the following:1. Add a CI Build or Security stage to your pipeline.2. Add a Wiz step to the stage.Set up the Wiz scannerRequired settings 1. \[Scan mode]\(#scan-mode) = \*\*Orchestration\*\* 3. \[Target type]\(#type) = \*\*Container image\*\* 2. \[Target and Variant Detection]\(#detect-target-and-variant) = \*\*Auto\*\* 3. Container image: 1. \[Type]\(#type-1) 2. \[Domain]\(#domain) — Required only if you're using a registry with a non-standard domain, such as a private registry. 3. \[Name]\(#name) — for example, \`jsmith/myimage\` 4. \[Tag]\(#name) — for example, \`latest\` 5. \[Authentication]\(#authentication) — Required only if the registry requires authentication: 1. \[Registry access Id]\(#access-id) as a Harness secret 2. \[Registry access token]\(#access-token) as a Harness secret 8. Authentication: 1. \[Wiz access ID]\(#access-id-1) as a Harness secret. This is your \`client-id\` to authenticate with the Wiz CLI. 2. \[Wiz access token]\(#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 debuggingPrerequisites- \[Harness text secrets]\(<https://app.gitbook.com/s/3F2TpHXhur2QtQnORSM9/use-harness-platform/secrets/add-use-text-secrets>) if your image registry requires an access Id and access token- \[Harness text secrets]\(<https://app.gitbook.com/s/3F2TpHXhur2QtQnORSM9/use-harness-platform/secrets/add-use-text-secrets>) for your \`client-id\` and \`client-secret\` to authenticate with the Wiz CLIAdd the Wiz scannerDo the following:1. Add a Build or Security stage to your pipeline.2. Add a Wiz step to the stage.Set up the Wiz scannerRequired settings 1. \[Scan mode]\(#scan-mode) = \*\*Orchestration\*\* 3. \[Target type]\(#type) = \*\*Container image\*\* 2. \[Target and Variant Detection]\(#target-and-variant-detection) = \*\*Auto\*\* 4. Container image: 1. \[Type]\(#type-1) 2. \[Domain]\(#domain) — Required only if you're using a registry with a non-standard domain, such as a private registry 3. \[Name]\(#name) — for example, \`jsmith/myimage\` 4. \[Tag]\(#name) — for example, \`latest\` 5. Authentication — Required only if the registry requires authentication: 1. \[Registry access Id]\(#access-id) as a Harness secret 2. \[Registry access token]\(#access-token) as a Harness secret 5. Authentication: 1. \[Wiz access ID]\(#access-id-1) as a Harness secret. This is your \`client-id\` to authenticate with the Wiz CLI. 2. \[Wiz access token]\(#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/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-ai/use-harness-platform/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/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/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/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/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/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-ai/use-harness-platform/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>

### Sample Pipeline <a href="#sample-pipeline" id="sample-pipeline"></a>

Here is a sample pipeline for artifact scans with Wiz Orchestration mode:

<details>

<summary>Sample YAML</summary>

```yaml
pipeline:
  name: cd-wiz-orchestration
  identifier: cdwizorchestration
  projectIdentifier: your_project_identifier
  orgIdentifier: your_org_identifier
  tags: {}
  stages:
    - stage:
        name: s1
        identifier: s1
        description: ""
        type: Deployment
        spec:
          deploymentType: Kubernetes
          service:
            serviceRef: your_service_identifier
          environment:
            environmentRef: your_environment_identifier
            deployToAll: false
            infrastructureDefinitions:
              - identifier: your_infrastructure_identifier
          execution:
            steps:
              - stepGroup:
                  name: sg
                  identifier: sg
                  steps:
                    - step:
                        type: Wiz
                        name: Wiz_1
                        identifier: Wiz_1
                        spec:
                          mode: orchestration
                          config: default
                          target:
                            type: container
                            detection: manual
                            name: test
                            variant: test
                          advanced:
                            log:
                              level: info
                          privileged: true
                          image:
                            type: docker_v2
                            tag: 14-alpine
                            name: library/node
                            domain: docker.io
                          auth:
                            access_token: your_access_token
                            access_id: your_access_id
                  stepGroupInfra:
                    type: KubernetesDirect
                    spec:
                      connectorRef: your_k8s_connector
            rollbackSteps: []
        tags: {}
        failureStrategies:
          - onFailure:
              errors:
                - AllErrors
              action:
                type: StageRollback

```

</details>

Here is a sample pipeline for artifact scans with Wiz Ingestion mode:

<details>

<summary>Sample YAML</summary>

```yaml
pipeline:
  name: wiz-ingestion1
  identifier: wizingestion1
  projectIdentifier: your_project_identifier
  orgIdentifier: default
  tags: {}
  stages:
    - stage:
        name: s1
        identifier: s1
        description: ""
        type: Deployment
        spec:
          deploymentType: Kubernetes
          service:
            serviceRef: your_service_identifier
          environment:
            environmentRef: your_environment_identifier
            deployToAll: false
            infrastructureDefinitions:
              - identifier: your_infrastructure_identifier
          execution:
            steps:
              - stepGroup:
                  name: sg1
                  identifier: sg1
                  steps:
                    - step:
                        type: Run
                        name: Run_1
                        identifier: Run_1
                        spec:
                          connectorRef: a
                          image: alpine
                          shell: Sh
                          command: |-
                            cat <<EOF >> example.json
                            {  
                               "meta":{  
                                  "key":[  
                                     "issueName",  
                                     "fileName"  
                                  ],  
                                  "subproduct":"MyCustomScanner"  
                               },  
                               "issues":[  
                                  {  
                                     "subproduct":"MyCustomScanTool",  
                                     "issueName":"Cross Site Scripting",  
                                     "issueDescription":"Lorem ipsum...",  
                                     "fileName":"homepage-jobs.php",  
                                     "remediationSteps":"Fix me fast.",  
                                     "risk":"high",  
                                     "severity":8,  
                                     "status":"open",  
                                     "referenceIdentifiers":[  
                                        {  
                                           "type":"cwe",  
                                           "id":"79"  
                                        }  
                                     ]  
                                  }  
                               ]  
                            }
                            EOF
                            ls
                            cat example.json
                    - step:
                        type: Wiz
                        name: Wiz_1
                        identifier: Wiz_1
                        spec:
                          mode: ingestion
                          config: default
                          target:
                            type: repository
                            detection: manual
                            name: external-scanner-test
                            variant: main
                          advanced:
                            log:
                              level: info
                          privileged: true
                          ingestion:
                            file: example.json
                  stepGroupInfra:
                    type: KubernetesDirect
                    spec:
                      connectorRef: your_k8s_connector
            rollbackSteps: []
        tags: {}
        failureStrategies:
          - onFailure:
              errors:
                - AllErrors
              action:
                type: StageRollback
```

</details>