Skip to main content

Mend (formerly Whitesource) scanner reference for STO

You can scan code repositories and container images using Mend.

Important notes for running Mend scans in STO​

Docker-in-Docker requirements​

The following use cases require a Docker-in-Docker background step in your pipeline:

  • Container image scans on Kubernetes and Docker build infrastructures
  • Security steps (not step palettes) on Kubernetes and Docker build infrastructures
    • Required for all target types and Orchestration/DataLoad modes

The following use cases do not require Docker-in-Docker:

Set up a Docker-in-Docker background step

  1. Go to the stage where you want to run the scan.

  2. In Overview, add the shared path /var/run.

  3. In Execution, do the following:

    1. Click Add Step and then choose Background.

    2. Configure the Background step as follows:

      1. Dependency Name = dind

      2. Container Registry = The Docker connector to download the DinD image. If you don't have one defined, go to Docker connector settings reference.

      3. Image = docker:dind

      4. Under Entry Point, add the following: dockerd

        In most cases, using dockerd is a faster and more secure way to set up the background step. For more information, go to the TLS section in the Docker quick reference.

      If the DinD service doesn't start with dockerd, clear the Entry Point field and then run the pipeline again. This starts the service with the default entry point.

      1. Under Optional Configuration, select the Privileged checkbox.
Configure the background step

Root access requirements​

You need to run the scan step with root access if either of the following apply:

note

You can set up your STO scan images and pipelines to run scans as non-root and establish trust for your own proxies using self-signed certificates. For more information, go to Configure STO to Download Images from a Private Registry.

For more information​

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

Mend step settings for STO scans​

The recommended workflow is add a Mend 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​

The predefined configuration to use for the scan. All scan steps have at least one configuration.

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.

  • Container Image Scan the layers, libraries, and packages in a container image.

Name​

The identifier for the target, 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 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 (repository)​

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.

Ingestion File​

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

  • 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​

Domain​

The fully-qualified URL to the scanner. The default is https://saas.whitesourcesoftware.com/api.

Enforce SSL​

The step and the scanner communicate over SSL by default. Set this to false to disable SSL (not safe).

Access Id​

The user key for your Mend personal account: in the Mend UI, click the Account Settings button in the top right.

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

Access Token​

The API key for your Mend organization.

This field is required. If you want to run a scan in an organization other than the default organization for your account, generate an Access Token in that specific organization. In the Mend UI, go to Integration > Organization > API Key.

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

Scan Tool​

Lookup Type​

You can specify the Mend product or project By Token or By Name.

Product Name / Token​

The name or token of the Mend product that you want to scan.

This field is required for Orchestration and Extraction scans.

Project Name / Token​

The name or token of the Mend project that you want to scan.

This field is required for Extraction scans.

Include​

If you're running an orchestration scan on a code repository, you can use this setting to specify the files to include in the scan. By default, a Mend scan includes all files in the code repository.

This setting corresponds to the Includes configuration parameter for the Mend United Agent.

Exclude​

If you're running an orchestration scan on a code repository, you can use this setting to specify the specific files to exclude from the scan. By default, a Mend scan includes all files in the code repository.

This setting corresponds to the excludes configuration parameter for the Mend United Agent.

Log Level, CLI flags, and Fail on Severity​

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 Mend scanner with specific command-line arguments.

Fail on Severity​

Every Security 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

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:

Security step settings for Mend scans in STO (legacy)​

note

You can set up Mend scans using a Security step, but this is a legacy functionality. Harness recommends that you use an Mend step instead.

Target and variant​

The following settings are required for every Security step:

  • target_name A user-defined label for the code repository, container, application, or configuration to scan.
  • variant A user-defined label for the branch, tag, or other target variant to scan.
note

Make sure that you give unique, descriptive names for the target and variant. This makes navigating your scan results in the STO UI much easier.

You can see the target name, type, and variant in the Test Targets UI:

Target name, type, and branch

For more information, go to Targets, baselines, and variants in STO.

Mend scan settings​

  • product_name = whitesource
  • policy_type = ingestionOnly, dataLoad, or orchestratedScan
  • scan_type = container or repository
  • product_domain (optional) — The default is https://saas.whitesourcesoftware.com/api.
  • product_access_id
  • product_access_token
  • product_include
  • product_config_name = default
  • fail_on_severity
  • tool_args You can add a tool_args setting to run the Mend Unified Agent with additional parameters. For example, you can save logs for STO-initiated scans in a separate folder on the Mend server like this: tool_args log.files.path /tmp/sto_scan_logs.

Lookup settings​

Lookup settings are required for dataLoad and orchestratedScan modes.

  • product_lookup_type You can specify the Mend product or project by token or by name.
    • When policy_type is set to dataLoad:
      • byName
      • byTokens
    • When policy_type is set to orchestratedScan:
      • appendToProductByName
      • appendToProductByToken

Required for dataLoad and orchestratedScan modes:

Required for dataLoad modes:

Container scan settings​

The following settings apply to all scanners where the scan_type is containerImage.

  • container_type
    • accepted value(s): local_image, docker_v2, jfrog_artifactory, aws_ecr
      • for container_type set to local
        • None
      • for container_type set to docker_v2
        • container_access_id: Username
        • container_access_token: Password/Token
      • for container_type set to jfrog_artifactory
        • container_access_id: Username
        • container_access_token: Password/Token
      • for container_type set to aws_ecr
        • container_access_id: Username
        • container_access_token: Password/Token
        • container_region: AWS default region
  • container_domain

Ingestion file​

If the policy_type is ingestionOnly:

  • ingestion_file = The path to your scan results when running an Ingestion scan, for example /shared/scan_results/myscan.latest.sarif.

  • 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

Mend orchestration pipeline example​

The following pipeline shows an end-to-end orchestration workflow. The Mend step includes the settings needed to run this specific scan: access_token, domain, access_id, and product_name.

pipeline:
  projectIdentifier: STO
  orgIdentifier: default
  tags: {}
  properties:
    ci:
      codebase:
        connectorRef: CODEBASE_CONNECTOR
        build: <+input>
  stages:
    - stage:
        name: mend
        identifier: mend
        type: SecurityTests
        spec:
          cloneCodebase: true
          infrastructure:
            type: KubernetesDirect
            spec:
              connectorRef: K8S_DELEGATE_CONNECTOR
              namespace: harness-delegate-ng
              automountServiceAccountToken: true
              nodeSelector: {}
              os: Linux
          execution:
            steps:
              - step:
                  type: Mend
                  name: mend_orch
                  identifier: mend_orch
                  spec:
                    mode: orchestration
                    config: default
                    target:
                      name: secrets
                      type: repository
                      variant: master
                    advanced:
                      log:
                        level: debug
                    resources:
                      limits:
                        memory: 1Gi
                    imagePullPolicy: Always
                    auth:
                      access_token: <+secrets.getValue("my-mend-organization-api-key")>
                      domain: https://saas.whitesourcesoftware.com/agent
                      ssl: true
                      access_id: <+secrets.getValue("my-mend-user-key")>
                    tool:
                      product_name: secretsrepo
          caching:
            enabled: false
          sharedPaths:
            - ""
        variables:
          - name: runner_tag
            type: String
            description: ""
            required: false
            value: latest
  identifier: mend_secrets
  name: mend - secrets