Skip to main content

Snyk Container scanning

The Snyk step in Harness STO allows you to find and fix vulnerabilities in container images based on container registry scans. This document helps you to configure Snyk step in your pipeline to perform Snyk Container scanning either through orchestration or ingestion scan modes in STO.

Refer to the Snyk step configuration document to learn more about the fields in the Snyk step and how to configure them.

Snyk Container scan - Orchestration mode​

To perform Snyk Container scanning with orchestration scan mode, follow the below steps:

  1. Search and add the Snyk step to your pipeline. You can use this step in Build stage or Security stage.

  2. In the step configuration, set the following fields

    1. Set the Scan Mode to Orchestration
    2. Under Target, set the Type to Container
    3. Set the Scan Configuration to Snyk Container
    4. For Target and Variant Detection it's preferred to use Auto option or you can define them using the Manual option.
    5. Under Container Image section, set the Type, Domain, Name, and Tag of your image.
    6. In Access Id and Access Token, you can pass the username and password of your container registry as Harness Secrets, which helps you access your private images. (Optional)
    7. Under Authentication, pass your Snyk API as Harness secret, for example: <+secrets.getValue("snyk_api_token")>

Refer to Snyk step configuration document to learn more about all the fields and their configurations.

Snyk Container scan - Ingestion mode​

In the Ingestion scan mode, the Snyk step reads data from a file, normalizes it, and deduplicates it. To perform a Snyk Container scan using the Ingestion scan mode, we will use two steps:

  1. Run Step: Scan the container with the Snyk CLI and save the results to a SARIF file.
  2. Snyk Step: Ingest the scan results from the SARIF file.

=

Requirements​

Go to the Overview tab of the stage. Under Shared Paths, enter the following path: /shared/scan_results, this will be the location where the Run step will save the scan results.

Configure Run step​

  1. Add the Run step to the pipeline and open the step configuration.

  2. In the Container Registry section, set your DockerHub connector. Snyk images will be pulled from their DockerHub account.

  3. For Image, use snyk/snyk:docker

  4. Set the Shell field to sh

  5. In the Command field, enter the following command.

    snyk container test \ snykgoof/big-goof-1g:100 -d \ --sarif-file-output=/shared/scan_results/snyk_container_scan.sarif  || true

Snyk maintains a set of snykgoof repositories that you can use for testing your container-image scanning workflows.

  1. In Optional Configuration, under Environment Variables, add a variable to access your Snyk API key:
    SNYK_TOKEN = <secrets.getValue("snyk_api_token")>
  2. In Advanced tab under Failure Strategies, set the Failure Strategy to Mark as Success. This step is required to ensure that the pipeline proceeds if Snyk finds a vulnerability. Otherwise, the build exits with an error code before STO can ingest the data.

=

Configure Snyk step​

  1. Add the Snyk step and open the step configuration.
  2. Set the Scan Mode to Ingestion.
  3. Set the Target Type to Container.
  4. For Target and Variant Detection, define them with the Manual option selected.
  5. In the Ingestion File field, enter /shared/scan_results/snyk_container_scan.sarif
  6. Apply your changes, save the configuration, and run the pipeline.

Refer to Snyk step configuration document to learn more about all the fields and their configurations.