Skip to main content

Code repository scans with Wiz



You can easily set up a Wiz step to run automated scans in your Harness pipelines. This step scans the code repository 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 Security Tests tab of the pipeline execution.

Important notes for running Wiz scans in STO​

The following topics contain useful information for setting up scanner integrations in STO:

Set-up workflows​

Orchestration scans for code repositories

Prerequisites​


Add the Wiz scanner​

Do the following:

  1. Add a Build or Security stage to your pipeline.
  2. Add a Wiz step to the stage.

Set up the Wiz scanner​

Required settings​
  1. Scan mode = Orchestration
  2. Target type = Repository
  3. Scan Configuration = Wiz Directory
  4. Target and Variant Detection = Auto
  5. Authentication:
    1. Wiz access ID as a Harness secret. This is your client-id to authenticate with the Wiz CLI.
    2. Wiz access token as a Harness secret. This is your client-secret to authenticate with the Wiz CLI.
Optional settings​
  • Fail on Severity — Stop the pipeline if the scan detects any issues at a specified severity or higher
  • Log Level — Useful for debugging
Ingestion scans for code repositories
note

Harness STO can ingest both JSON and SARIF data from Wiz, but Harness recommends publishing to JSON because this format includes more detailed information.

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.

Set up the Wiz scanner​

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

Required settings​
  1. Scan mode = Ingestion
  2. Target type = Code Repository
  3. Target name — Usually the repo name
  4. Target variant — Usually the scanned branch. You can also use a runtime input and specify the branch at runtime.
  5. Ingestion file — For example, /shared/scan_results/wiz-scan.json
  6. Save the pipeline and select Visual.
Optional settings​
  • Fail on Severity — Stop the pipeline if the scan detects any issues at a specified severity or higher
  • Log Level — Useful for debugging

Wiz step settings reference​

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​

Scan Mode​

  • Orchestration Configure the step to run a scan and then ingest, normalize, and deduplicate the results.

Scan Configuration​

Select Wiz Directory.

Target​

Type​

  • Repository Scan a codebase repo.

    In most cases, you specify the codebase using a code repo connector that connects to the Git account or repository where your code is stored. For information, go to Configure codebase.

Target and Variant Detection​

When Auto is enabled for code repositories, the step detects these values using git:

  • To detect the target, the step runs git config --get remote.origin.url.
  • To detect the variant, the step runs git rev-parse --abbrev-ref HEAD. The default assumption is that the HEAD branch is the one you want to scan.

Note the following:

  • Auto is not available when the Scan Mode is Ingestion.
  • Auto is the default selection for new pipelines. Manual is the default for old pipelines, but you might find that neither radio button is selected in the UI.

Name​

The identifier for the target such codebaseAlpha. Descriptive target names make it much easier to navigate your scan data in the STO UI.

It is good practice to specify a baseline for every target.

Variant​

The identifier for the specific variant to scan. This is usually the branch name, image tag, or product version. Harness maintains a historical trend for each variant.

Workspace​

The workspace path on the pod running the scan step. The workspace path is /harness by default.

You can override this if you want to scan only a subset of the workspace. For example, suppose the pipeline publishes artifacts to a subfolder /tmp/artifacts and you want to scan these artifacts only. In this case, you can specify the workspace path as /harness/tmp/artifacts.

Artifacts​

Type​

The registry type where the image is stored:

Domain​

The URL of the registry that contains the image to scan. Examples include:

  • docker.io
  • app.harness.io/registry
  • us-east1-docker.pkg.dev
  • us.gcr.io

Name​

The image name. For non-local images, you also need to specify the image repository. Example: jsmith/myalphaservice

Tag​

The image tag. Examples: latest, 1.2.3

Access ID​

The username to log in to the image registry.

Access Token​

The access token used to log in to the image registry. This is usually a password or an API key.

You should create a Harness text secret with your encrypted token and reference the secret using the format <+secrets.getValue("container-access-id")>. For more information, go to Add and Reference Text Secrets.

Ingestion File​

The path to your scan results when running an Ingestion scan, for example /shared/scan_results/wiz.latest.json.

  • The data file must be in a supported format 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 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:

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

Authentication​

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.

Log Level​

The minimum severity of the messages you want to include in your scan logs. You can specify one of the following:

  • DEBUG
  • INFO
  • WARNING
  • ERROR

Additional CLI flags​

Use this field to run the scanner binary with additional flags supported by the external scanner.

caution

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.

Fail on Severity​

Every Custom Scan step has a Fail on Severity setting. If the scan finds any vulnerability with the specified severity level or higher, the pipeline fails automatically. You can specify one of the following:

  • CRITICAL
  • HIGH
  • MEDIUM
  • LOW
  • INFO
  • NONE — Do not fail on severity

The YAML definition looks like this: fail_on_severity : critical # | high | medium | low | info | none

Settings​

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

Additional Configuration​

In the Additional Configuration settings, you can use the following options:

Advanced settings​

In the Advanced settings, you can use the following options: