> 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/use-sto/sto-scanner-configuration/sysdig-scanner-reference.md). # Sysdig step configuration You can scan container images using [Sysdig Vulnerability engine](https://docs.sysdig.com/en/docs/sysdig-secure/vulnerabilities/). Add a Sysdig step to a Build or Security stage and then configure it as described below. ### Important notes for running Sysdig scans in STO * You need to run the scan step with root access if either of the following apply: * You need to run a [Docker-in-Docker background service](/security-testing-orchestration/use-sto/sto-scanner-configuration/security-step-settings-reference.md#configuring-docker-in-docker-dind-for-your-pipeline). * You need to add trusted certificates to your scan images at runtime. * You can set up your STO scan images and pipelines to run scans as non-root and establish trust for your own 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). The following topics contain useful information for setting up scanner integrations in STO: * [What's supported in STO](/security-testing-orchestration/new-to-sto/sto-whats-supported/sto-deployments.md) * [Security Testing Orchestration FAQs](/security-testing-orchestration/troubleshooting-and-resources/faqs.md) * [Optimize STO pipelines](/security-testing-orchestration/troubleshooting-and-resources/sto-use-cases/set-up-sto-pipelines/optimize-sto-pipelines.md) ### Sysdig step settings for STO scans The recommended workflow is to add a Sysdig step to a Security or Build stage and then configure it as described below. #### Scan **Scan Mode** * **Orchestration** Configure the step to [run a scan](/security-testing-orchestration/new-to-sto/key-concepts/run-an-orchestrated-scan-in-sto.md) and then ingest, normalize, and deduplicate the results. * **Ingestion** Configure the step to [read scan results from a data file](/security-testing-orchestration/new-to-sto/key-concepts/ingest-scan-results-into-an-sto-pipeline.md) and then ingest, normalize, and deduplicate the data. **Scan Configuration** The predefined configuration to use for the scan. All scan steps have at least one configuration. #### Target **Type** * **Container Image** Scan the layers, libraries, and packages in a container image. **Target and Variant Detection** When **Auto** is enabled for container images, the step detects the target and variant using the **Container Image Name** and **Tag/Digest** defined in the step or runtime input. Note the following: * **Auto** is not available when the **Scan Mode** is **Ingestion**. * By default, **Auto** is selected when you add the step. You can change this setting if needed. **Name** The identifier for the [target](/security-testing-orchestration/new-to-sto/key-concepts/targets-and-baselines.md), such as `codebaseAlpha` or `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** 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. #### Container image **Type** The registry type where the image is stored: * **Docker v2** A registry that uses the Docker Registry v2 API such as [Docker Hub](https://docs.docker.com/registry/spec/api/), [Google Container Registry](https://cloud.google.com/container-registry), or [Google Artifact Registry](https://cloud.google.com/artifact-registry). STO will automatically pull and scan the container image or OCI/Docker archive. * [**AWS ECR**](https://aws.amazon.com/ecr/) Set your AWS ECR connector with image details. STO will automatically pull and scan the container image or OCI/Docker archive. * [**Jfrog Artifactory**](https://jfrog.com/artifactory/) Set your Jfrog Artifactory connector with image details. STO will automatically pull and scan the container image or OCI/Docker archive. * **Local Image in this Stage** Scan a local image built and stored within the context of the current stage (via `/var/run/docker.sock` registered as a stage level volume mount). For this, you will need to [configure Docker-in-Docker](/security-testing-orchestration/use-sto/sto-scanner-configuration/security-step-settings-reference.md#configuring-docker-in-docker-dind-for-your-pipeline) as a background step. STO will identify and scan the container image matching the step configuration inside the Docker-in-Docker background within that stage. * **Local OCI/Docker archive in this Stage** Scan an OCI or Docker archive created and stored within the current stage. STO will scan the archive based on the path configured in the workspace field during the step. Ensure that the path to which the archive is saved is a shared volume mount. **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` **Name** The image name. For non-local images, you also need to specify the image repository. Example: `jsmith/myalphaservice` **Tag/Digest** The image tag or digest. Examples: `latest`, `1.2.3`, `@sha256:abc123...` **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](/harness-ai/use-harness-platform/secrets/add-use-text-secrets.md). **Region** The region where the image to scan is located, as defined by the cloud provider such as AWS. #### Ingestion File 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/myscan.latest.sarif`. * 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 ``` #### 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** {% hint style="warning" %} Passing additional CLI flags is an advanced feature. Harness recommends the following best practices: * Test your flags and arguments thoroughly before you use them in your Harness pipelines. Some flags might not work in the context of STO. * Don't add flags that are already used in the default configuration of the scan step. To check the default configuration, go to a pipeline execution where the scan step ran with no additional flags. Check the log output for the scan step. You should see a line like this: `Command [ scancmd -f json -o /tmp/output.json ]` In this case, don't add `-f` or `-o` to **Additional CLI flags**. {% endhint %} #### Fail on Severity Every STO scan step has a **Fail on Severity** setting. If the scan finds any vulnerability with the specified [severity level](/security-testing-orchestration/new-to-sto/key-concepts/severities.md) 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` #### Additional Configuration The fields under **Additional Configuration** vary based on the type of infrastructure. Depending on the infrastructure type selected, some fields may or may not appear in your settings. Below are the details for each field * Override Security Test Image * [Container Registry](/security-testing-orchestration/troubleshooting-and-resources/sto-use-cases/set-up-sto-pipelines/configure-pipeline-to-use-sto-images-from-private-registry.md#step-level-override) * [Image Tag](/security-testing-orchestration/troubleshooting-and-resources/sto-use-cases/set-up-sto-pipelines/configure-pipeline-to-use-sto-images-from-private-registry.md#step-level-override) * [Privileged](/continuous-integration/use-harness-ci/use-harness-ci/manage-dependencies/background-step-settings.md#privileged) * [Image Pull Policy](/continuous-integration/use-harness-ci/use-harness-ci/manage-dependencies/background-step-settings.md#image-pull-policy) * [Run as User](/continuous-integration/use-harness-ci/use-harness-ci/manage-dependencies/background-step-settings.md#run-as-user) * [Set Container Resources](/continuous-integration/use-harness-ci/use-harness-ci/manage-dependencies/background-step-settings.md#set-container-resources) * [Timeout](/continuous-integration/use-harness-ci/use-harness-ci/run-step-settings.md#timeout) #### Advanced settings In the **Advanced** settings, you can use the following options: * [Conditional Execution](/harness-ai/use-harness-platform/pipelines/step-skip-condition-settings.md) * [Failure Strategy](/harness-ai/use-harness-platform/pipelines/failure-handling/define-a-failure-strategy-on-stages-and-steps.md) * [Looping Strategy](/harness-ai/use-harness-platform/pipelines/looping-strategies/looping-strategies-matrix-repeat-and-parallelism.md) * [Policy Enforcement](/harness-ai/use-harness-platform/governance/policy-as-code/harness-governance-overview.md) ### Proxy settings This step supports private network connectivity if you're using Harness Cloud infrastructure. For information on connectivity options, see [Private network connectivity options](/harness-ai/use-harness-platform/references/private-network-connectivity/private-network-connectivity.md). When using proxy configurations, the `HTTPS_PROXY` and `HTTP_PROXY` variables are automatically set to route traffic through the secure tunnel. If there are specific addresses that you want to bypass the proxy, you can define those in the `NO_PROXY` variable. This can be configured in the **Settings** of your step. If you need to configure a different proxy, you can manually set the `HTTPS_PROXY`, `HTTP_PROXY`, and `NO_PROXY` variables in the **Settings** of your step. **Definitions of Proxy variables:** * `HTTPS_PROXY`: Specify the proxy server for HTTPS requests, example `https://sc.internal.harness.io:30000` * `HTTP_PROXY`: Specify the proxy server for HTTP requests, example `http://sc.internal.harness.io:30000` * `NO_PROXY`: Specify the domains as comma-separated values that should bypass the proxy. This allows you to exclude certain traffic from being routed through the proxy. ### Sysdig pipeline examples #### Sysdig orchestration pipeline If you copy this example, replace the placeholder values with appropriate values for your project, organization, connectors, and access token.
YAML pipeline, Sysdig scan, Orchestration mode ```yaml pipeline: name: sysdig test identifier: sysdig_test projectIdentifier: default orgIdentifier: default tags: {} stages: - stage: name: scan identifier: scan type: SecurityTests spec: cloneCodebase: false execution: steps: - step: type: Background name: docker identifier: docker spec: connectorRef: YOUR_DOCKER_CONNECTOR_ID image: docker:dind shell: Sh privileged: true resources: limits: memory: 2Gi cpu: 1000m - step: type: Sysdig name: Sysdig_1 identifier: Sysdig_1 spec: mode: orchestration config: default target: name: nodegoat type: container variant: latest advanced: log: level: debug privileged: true image: type: docker_v2 name: vulnerables/web-dvwa tag: latest auth: access_token: <+secrets.getValue("YOUR_SYSDIG_ACCESS_TOKEN_SECRET")> domain: https://app.us4.sysdig.com imagePullPolicy: Always resources: limits: memory: 2Gi failureStrategies: - onFailure: errors: - AllErrors action: type: MarkAsSuccess - step: type: Run name: Run_1 identifier: Run_1 spec: connectorRef: YOUR_DOCKER_CONNECTOR_ID image: alpine shell: Sh command: cat /harness/scan-logs failureStrategies: - onFailure: errors: - AllErrors action: type: MarkAsSuccess sharedPaths: - /addon/results - /var/run infrastructure: type: KubernetesDirect spec: connectorRef: YOUR_KUBERNETES_CLUSTER_CONNECTOR_ID namespace: YOUR_NAMESPACE automountServiceAccountToken: true nodeSelector: {} os: Linux ```
#### Sysdig ingestion pipeline If you copy this example, replace the placeholder values with appropriate values for your project, organization, connectors, and access token.
YAML pipeline, Sysdig scan, Ingestion mode ```yaml pipeline: projectIdentifier: YOUR_PROJECT_ID orgIdentifier: YOUR_HARNESS_ORG_ID tags: {} stages: - stage: name: sysdig_ingest_scan identifier: sysdig_ingest_scan type: CI spec: cloneCodebase: true platform: os: Linux arch: Amd64 runtime: type: Cloud spec: {} execution: steps: - step: type: Run name: Run_1 identifier: Run_1 spec: shell: Sh command: |- # In this example, the codebase connector points to # https://github.com/GitHubGoneMad/sysdig-scans cp /harness/sysdig-scan-results.json /shared/scan_results/ - step: type: Sysdig name: Sysdig_1 identifier: Sysdig_1 spec: mode: ingestion config: default target: type: container detection: manual name: YOUR_CONTAINER_IMAGE_REPO/NAME variant: YOUR_CONTAINER_IMAGE_NAME advanced: log: level: info privileged: false ingestion: file: /shared/scan_results/sysdig-scan-results.json sharedPaths: - /shared/scan_results/ properties: ci: codebase: connectorRef: YOUR_CODE_REPO_CONNECTOR_ID repoName: YOUR_REPO_NAME build: <+input> identifier: sysdig_ingestion_test_v2 name: sysdig_ingestion_test_v2 ```