Skip to main content

Generate and Attest SBOM with Harness GitLab CI/CD

Last updated on

Modern applications rely on a large number of open-source and third-party components. Without an accurate inventory of these components, it becomes difficult to identify security vulnerabilities, understand license obligations, and maintain visibility into software dependencies across the software supply chain.

Harness Supply Chain Security (SCS) integrates with GitLab CI/CD to automate software supply chain security tasks within your CI/CD workflow. It enables you to generate a Software Bill of Materials (SBOM) during pipeline execution. The generated SBOM provides an inventory of software components used in your application. This helps improve software supply chain visibility and supports vulnerability management, license compliance, and governance throughout the software development lifecycle.

What will you learn in this topic?​

By the end of this topic, you will be able to:

  • Set up Harness GitLab CI/CD integration from your SCS project.
  • Configure SBOM generation in your GitLab CI/CD workflow using the SBOM Orchestration component.
  • Configure optional SBOM attestation using keyless, key-based, or Secret Manager signing methods.
  • Generate and upload an SBOM to the SCS module as part of your GitLab CI/CD pipeline.

Before you begin​

Make a note of the following before you proceed with generating an SBOM using GitLab CI/CD:

  • Understand how to create Harness API keys using Personal API Keys or Service Account API Keys. For more information, go to Manage API Keys and Service Account API Keys, respectively.
  • If you're using key-based or Secret Manager signing or verification, create or configure a Cosign key pair before configuring the pipeline. For step-by-step instructions, see Quickstart Signing and Verifying with Cosign, which explains how to generate a local key pair or create one using a supported KMS provider. The key should be generated using Cosign of type ecdsa-P256. You don't need to install Cosign on your GitLab runner. The harness/ssca-plugin container image used by the Harness GitLab CI/CD components includes Cosign, so no additional installation is required.
  • If you plan to use Secret Manager attestation, store your signing key in a supported secret manager. Currently, Harness supports HashiCorp Vault. For GitLab CI/CD, you point the component at the key through pipeline variables such as KMS_KEY (and VAULT_ADDR when the key is stored in HashiCorp Vault), so you don't need to configure a Harness Secret Manager connector. For setup steps specific to HashiCorp Vault, see the Add a HashiCorp Vault secret manager.
  • Ensure that your GitLab runners support Docker-in-Docker (DinD). The component runs using the docker:24-dind service. For more information, go to Use Docker-in-Docker.

Understand SBOM generation with Harness GitLab CI/CD​

Harness SCS integrates with GitLab CI/CD through reusable GitLab CI/CD components. These components enable you to automate software supply chain security tasks as part of your GitLab pipelines, helping you build, verify, and govern software artifacts without adding custom implementation to your CI/CD workflow.

The SBOM generation capability creates an SBOM for a container image or a local (non-container) artifact during pipeline execution. The generated SBOM is uploaded to the SCS module, where you can review the software components included in your application. This helps you identify software dependencies, investigate vulnerabilities, review license information, and maintain visibility into your software supply chain.

You can also attest the generated SBOM to establish its authenticity and integrity. Harness GitLab CI/CD supports keyless, key-based, and Secret Manager attestation methods. With keyless attestation, SCS uses an OpenID Connect (OIDC) identity to sign the SBOM, eliminating the need for long-lived signing keys. With key-based attestation, SCS uses a cryptographic key that you manage through your preferred key management solution. With Secret Manager attestation, SCS uses a signing key stored in a supported secret manager. Key-based and Secret Manager container attestations are stored alongside the artifact in the configured container registry. Keyless container attestations and all local-artifact attestations are uploaded to the SCS module as bundles.

Why use it?When to use it?How can you leverage it?
Generate an inventory of the software components used in your application.When you want to automatically generate an SBOM as part of your GitLab CI/CD pipeline.Use the generated SBOM to gain visibility into software dependencies, identify vulnerabilities, review license information, attest software artifacts, and support governance and compliance initiatives.

Set up Harness GitLab CI/CD​

Before configuring SBOM generation in your GitLab pipeline, set up Harness GitLab CI/CD from your SCS project. The setup guides you through creating or selecting a Harness API key and generates a project-specific YAML configuration with your Harness account ID, organization ID, project ID, and account URL already populated. You can copy this configuration into your GitLab workflow and update the remaining inputs as needed.

Complete the following steps to set up Harness GitLab CI/CD:

  1. Navigate to the Integrations page under the Manage section from the sidebar navigation of your SCS account.
  2. Click the Add Integration button to go to the Configure Integration page.
    Alternatively, you can access this page by clicking Get Started > Get Started from the sidebar navigation of your SCS account.
  3. Scroll down to the GitLab collapsible and click it to expand.
  4. Click the Configure button under Configure GitLab CI/CD in your pipeline to generate SBOM and SLSA, and sign artifacts to open the Configure Integration page, where the Artifact Security feature cards are displayed.
  5. Click the Generate SBOM card to open the SBOM Generation sidepanel.
  6. Click the Go to Key Generation button to create the Harness API key required to configure Harness GitLab CI/CD.
    • Select Using Service Account from the dropdown to create the API key using a service account. For more information, see Service Account API Keys.
    • Select Using Personal Account from the dropdown to create a personal API key. Personal API keys are created at the account level and inherit the permissions assigned to your user account. For more information, see Manage API Keys.
  7. Click Copy in the upper-right corner of the code block to copy the generated GitLab CI/CD configuration, and then paste it into your GitLab workflow file.

Configure SBOM generation in GitLab CI/CD​

After setting up Harness GitLab CI/CD, configure the SBOM Orchestration component in your GitLab workflow file. Add the required GitLab CI/CD variables to your GitLab project, configure the component inputs, the attestation settings, and run the pipeline. During pipeline execution, the component generates an SBOM for the specified artifact and uploads it to the SCS module. For the authoritative list of component inputs and defaults, see the CI/CD Catalog at SCS GitLab Plugins.

Complete the following steps to configure SBOM generation:

  1. Add the required GitLab CI/CD variables
  2. Include the SBOM Orchestration component
  3. (Optional) Configure SBOM attestation in the workflow
  4. Review the workflow
  5. Run the pipeline

Step 1 - Add the required GitLab CI/CD variables​

Before configuring the SBOM Orchestration component, add the following variables to your GitLab project. For step by step instructions, see Define a CI/CD Variable for a project.

VariableDescriptionRequiredExampleMasked?
HARNESS_API_KEYHarness Personal API Key or Service Account API Key used to authenticate with Harness.Yespat.xxxxxxxxxxxxxxxxxxxxYes
HARNESS_ACCOUNT_IDHarness account identifier.YesAbCdEf123456No
HARNESS_ORG_IDHarness organization identifier.YesSCS_OrgNo
HARNESS_PROJECT_IDHarness project identifier.YesSCSNo
HARNESS_ACCOUNT_URLHarness account URL.Yeshttps://example.harness.ioNo
note

Masked GitLab CI/CD variables cannot be passed through component inputs. For this reason, the Harness scope variables (HARNESS_ACCOUNT_ID, HARNESS_ORG_ID, HARNESS_PROJECT_ID, and HARNESS_ACCOUNT_URL) must remain unmasked so that they can be wired through the component inputs. HARNESS_API_KEY remains masked and is consumed directly from the job environment, not passed as a component input. These values are included in the generated YAML provided during the Set up Harness GitLab CI/CD workflow.

Step 2 - Include the SBOM Orchestration component​

Add an scs stage to your GitLab workflow file, or set the stage input on the component to an existing stage. Then, include the Harness SBOM Orchestration component in your GitLab workflow file.

The following code snippet demonstrates how to add the scs stage and include the SBOM Orchestration component in your GitLab workflow file. The snippet includes the minimum required component inputs because the component requires the Harness scope variables and the target artifact to run.

stages: [scs]

include:
  - component: gitlab.com/harness-scs/gitlab-plugins/sbom-orchestration@1.0.0
    inputs:
      HARNESS_ACCOUNT_ID: $HARNESS_ACCOUNT_ID
      HARNESS_ORG_ID: $HARNESS_ORG_ID
      HARNESS_PROJECT_ID: $HARNESS_PROJECT_ID
      HARNESS_ACCOUNT_URL: $HARNESS_ACCOUNT_URL
      TARGET: $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA

Configure the component using the GitLab CI/CD variables created in the previous step and the following component inputs.

InputDescriptionRequiredDefaultExample
HARNESS_ACCOUNT_IDHarness account ID. Pass a non-masked CI/CD variable reference.YesN/A$HARNESS_ACCOUNT_ID
HARNESS_ORG_IDHarness organization ID. Pass a non-masked CI/CD variable reference.YesN/A$HARNESS_ORG_ID
HARNESS_PROJECT_IDHarness project ID. Pass a non-masked CI/CD variable reference.YesN/A$HARNESS_PROJECT_ID
HARNESS_ACCOUNT_URLHarness base URL with scheme. Pass a non-masked CI/CD variable reference.YesN/A$HARNESS_ACCOUNT_URL
TARGETContainer image reference or local artifact path for which the SBOM is generated.YesN/A$CI_REGISTRY_IMAGE:$CI_COMMIT_SHA
SOURCESource type. Supported values are container and local.Nocontainerlocal
TOOLSBOM generation tool. Supported values are Syft and cdxgen.NoSyftcdxgen
FORMATSBOM output format. Supported values are spdx-json and cyclonedx-json.Nospdx-jsoncyclonedx-json
ATTESTEnables SBOM attestation.Nofalsetrue
SBOM_OUTPUT_DIRDirectory where the generated SBOM is stored.Notmpoutput
ARTIFACT_NAMEDisplay name for a local artifact. Applicable when SOURCE=local.NoFile name from TARGETpayment-service
ARTIFACT_VERSIONArtifact version. Applicable when SOURCE=local.NoN/A$CI_COMMIT_SHORT_SHA
stageGitLab pipeline stage in which the component runs.Noscssecurity
job-nameName of the GitLab job created by the component.Noscs-sbom-orchestrationgenerate-sbom
note

By default, the component generates an SBOM for a container image. To generate an SBOM for a local artifact, set SOURCE to local. When using a local artifact, specify the artifact path in TARGET and provide an ARTIFACT_VERSION.

To attest the generated SBOM, configure the attestation inputs (ATTEST_WITH, OIDC_PROVIDER, FULCIO_URL, KMS_KEY, and VAULT_ADDR) as described in (Optional) Step 3 - Configure SBOM attestation.

Override the generated job​

Standard GitLab job keywords, such as needs, before_script, script, after_script, allow_failure, and tags, are not component inputs. To set them, redeclare the generated job (default name scs-sbom-orchestration, or the value of job-name) in your workflow file. GitLab merges your keys into the generated job.

scs-sbom-orchestration:
  needs: [build-image]
  tags: [docker, linux]
  before_script:
    - echo "Starting SBOM orchestration"
  after_script:
    - echo "SBOM generation complete"
note

If you are generating an SBOM for an image in a private registry that is not the GitLab container registry, provide the registry credentials as masked GitLab CI/CD variables so that the component can access the image.

(Optional) Step 3 - Configure SBOM attestation​

Harness supports the following attestation methods:

  • Keyless attestation – Uses OpenID Connect (OIDC) identities to sign the generated SBOM without managing long-lived signing keys.
  • Key-based attestation – Uses a cryptographic key managed through your organization's key management solution.
  • Secret Manager – Uses signing keys stored in a supported secret manager.
note

SBOM attestation is disabled by default (ATTEST: false). The component generates and uploads the SBOM without signing it. If you plan to verify the SBOM attestation during SBOM policy enforcement (with VERIFY: true), set ATTEST: true to generate a signed attestation.

Configure the appropriate attestation inputs based on the attestation method you want to use.

If you enable SBOM attestation, you can configure keyless attestation to sign the generated SBOM using an OpenID Connect (OIDC) identity. For GitLab CI/CD, set OIDC_PROVIDER to non-harness. The harness OIDC provider is not supported as of now. Keyless attestation requires GitLab 15.7 or later, because it depends on GitLab id_tokens. Configure the following inputs.

InputDescriptionRequired
ATTEST_WITHSpecifies the attestation method. Set the value to keyless.Yes
OIDC_PROVIDEROIDC provider used to obtain the signing identity. For GitLab CI/CD, set the value to non-harness.Yes
FULCIO_URLFulcio certificate authority endpoint. Used when OIDC_PROVIDER is non-harness. Defaults to https://fulcio.sigstore.dev.No

Provide the OIDC token to the generated job using id_tokens. The component reads the token from PLUGIN_NON_HARNESS_OIDC_TOKEN.

stages: [scs]
 
include:
  - component: gitlab.com/harness-scs/gitlab-plugins/sbom-orchestration@1.0.0
    inputs:
      HARNESS_ACCOUNT_ID: $HARNESS_ACCOUNT_ID
      HARNESS_ORG_ID: $HARNESS_ORG_ID
      HARNESS_PROJECT_ID: $HARNESS_PROJECT_ID
      HARNESS_ACCOUNT_URL: $HARNESS_ACCOUNT_URL
      TARGET: $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA
      ATTEST: "true"
      ATTEST_WITH: keyless
      OIDC_PROVIDER: non-harness

scs-sbom-orchestration:
  id_tokens:
    PLUGIN_NON_HARNESS_OIDC_TOKEN:
      aud: sigstore

Step 4 - Review the workflow​

After configuring the required GitLab CI/CD variables and component inputs, your GitLab workflow file should resemble the following example. This example generates an SBOM for a container image in Harness SCS and optionally attests the generated SBOM using Cosign with a key stored in HashiCorp Vault. The Harness scope variables are wired through inputs, HARNESS_API_KEY remains a masked GitLab CI/CD variable, and the Vault variables (KMS_KEY and VAULT_ADDR) are provided because attestation is enabled.

include:
  - component: gitlab.com/harness-scs/gitlab-plugins/sbom-orchestration@1.0.0
    inputs:
      HARNESS_ACCOUNT_ID: $HARNESS_ACCOUNT_ID
      HARNESS_ORG_ID: $HARNESS_ORG_ID
      HARNESS_PROJECT_ID: $HARNESS_PROJECT_ID
      HARNESS_ACCOUNT_URL: $HARNESS_ACCOUNT_URL
      TARGET: $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA
      ATTEST: "true"
      ATTEST_WITH: secret-manager
      KMS_KEY: hashivault://cosign
      VAULT_ADDR: $VAULT_ADDR

Step 5 - Run the pipeline​

Commit your changes and run the GitLab pipeline. During pipeline execution, the SBOM Orchestration component analyzes the specified target, generates an SBOM, and uploads it to the SCS module. If SBOM attestation is enabled, the component also generates and signs an SBOM attestation using the configured attestation method. For more information on running a GitLab pipeline, see Tutorial: Create and run your first GitLab CI/CD pipeline.

After the pipeline completes, open the job execution logs and click the Harness Artifact Details link to view the generated artifact in SCS. For more information on viewing the status of a job and details of the pipeline, see View the status of your pipeline and jobs.

The Artifact Details page displays the generated SBOM and its associated security results. The SBOM is also automatically recorded in the Chain of Custody, providing an immutable audit trail of the artifact lifecycle and the associated GitLab CI/CD pipeline execution. For more information on navigating through artifacts, see Artifact Overview.

Example SBOM generation workflow​

Example SBOM generation workflow for a container image

The following example demonstrates how to configure the SBOM Orchestration component in a GitLab workflow to generate an SBOM for a container image. The example also shows how to optionally attest the generated SBOM using Cosign with a key stored in HashiCorp Vault. HARNESS_API_KEY is consumed as a masked GitLab CI/CD variable and is not passed as a component input.

stages:
  - build
  - scs
 
build-image:
  stage: build
  image: docker:24.0.5
  services:
    - docker:24.0.5-dind
  script:
    - docker build -t $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA .
    - docker push $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA
 
include:
  - component: gitlab.com/harness-scs/gitlab-plugins/sbom-orchestration@1.0.0
    inputs:
      stage: scs
      job-name: generate-sbom
      HARNESS_ACCOUNT_ID: $HARNESS_ACCOUNT_ID
      HARNESS_ORG_ID: $HARNESS_ORG_ID
      HARNESS_PROJECT_ID: $HARNESS_PROJECT_ID
      HARNESS_ACCOUNT_URL: $HARNESS_ACCOUNT_URL
 
      TARGET: $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA
 
      SOURCE: container
      TOOL: Syft
      FORMAT: spdx-json
 
      ATTEST: "true"
      ATTEST_WITH: secret-manager
      KMS_KEY: hashivault://cosign
      VAULT_ADDR: $VAULT_ADDR
Example SBOM generation workflow for a local artifact

The following example generates an SBOM for a local artifact. It builds the artifact in an earlier job, passes it forward with artifacts, and uses needs so the SBOM job runs after the artifact is available. When SOURCE is local, TARGET is the artifact file path and ARTIFACT_VERSION is required.

stages:
  - build
  - scs
 
build-artifact:
  stage: build
  script:
    - ./build.sh -o $CI_PROJECT_DIR/payment-service.jar
  artifacts:
    paths:
      - payment-service.jar
 
scs-sbom-orchestration:
  needs: [build-artifact]
 
include:
  - component: gitlab.com/harness-scs/gitlab-plugins/sbom-orchestration@1.0.0
    inputs:
      HARNESS_ACCOUNT_ID: $HARNESS_ACCOUNT_ID
      HARNESS_ORG_ID: $HARNESS_ORG_ID
      HARNESS_PROJECT_ID: $HARNESS_PROJECT_ID
      HARNESS_ACCOUNT_URL: $HARNESS_ACCOUNT_URL
 
      SOURCE: local
      TARGET: $CI_PROJECT_DIR/payment-service.jar
      ARTIFACT_NAME: payment-service
      ARTIFACT_VERSION: $CI_COMMIT_SHORT_SHA

Next steps​