Skip to main content
Skip table of contents

Create or Update a Project by Importing an SBOM File

Overview

Mend.io enables you to import an SBOM file, to update an existing project in the application or create a new one.

An SBOM file traditionally specifies the libraries, code packages, and other third-party components that are used in your project.

Once imported, licensing and vulnerability data will be associated with your project’s dependencies, like any other project scanned into the application. Projects created or updated via SBOM imports will be regularly monitored for new vulnerabilities and updates.

What’s Supported?

Mend.io allows you to import SBOM files exported by the following tools:

Supported Standards and Schema Requirements

The supported SBOM standards are CycloneDX (versions 1.4, 1.5, 1.6) and SPDX (versions 2.2, 2.3).
Note: For CycloneDX 1.6, only semantic support is available.
CBOM, CDXA, and AI/ML are not supported.

The supported formats are JSON and XML.

Read more about the schema requirements for SPDX and CycloneDX to ensure a smooth import, especially when creating and importing a self-generated SBOM.

CPE Support

When a package in your SBOM has no Package-URL (PURL), the importer will attempt to identify it using CPE (Common Platform Enumeration) as a fallback.

  • PURL always takes precedence when present.

  • For best coverage, Mend.io recommends ensuring your SBOM generation tool produces PURL identifiers. CPE is a useful fallback but PURL provides unambiguous package identification. Tools like Syft, Trivy, and Black Duck typically produce PURLs for most packages.

Note: Both CPE 2.2 and CPE 2.3 formats are supported.

CPE Best Practices

Mend.io resolves packages from CPE by using the vendor field to determine the package ecosystem. A well-formed CPE looks like:

CODE
cpe:2.3:a:<vendor>:<product>:<version>:*:*:*:*:*:*:*

For best results, the vendor field should identify the organization or ecosystem that publishes the package — not the package name itself.

Multiple CPE entries

When a package has multiple CPE entries (common in Black Duck SBOMs), the importer will pick the first one with a recognized vendor. This means even if one CPE is ambiguous, a second CPE with a known vendor will work.

Java/Maven Special Handling

For Java packages, Mend includes a built-in lookup table that maps CPE vendor+product pairs to Maven coordinates (groupId and artifactId). This covers popular libraries from Apache, Spring, Eclipse, and many others. For example:

  • cpe:2.3:a:pivotal_software:spring-boot:2.7.0:*:*:*:*:*:*:* resolves to org.springframework.boot:spring-boot

  • cpe:2.3:a:apache:struts:2.5.30:*:*:*:*:*:*:* resolves to org.apache.struts:struts

Limitations

  • Vendor = Package Name: The importer will not import a package when the vendor is just the package name repeated, e.g., cpe:2.3:a:bash:bash:5.2.15:*:*:*:*:*:*:*

  • Vendor Ambiguity: The importer will not import a package when the vendor exists across multiple ecosystems, e.g., cpe:2.3:a:protobuf:protobuf:1.4.2:*:*:*:*:*:*:* (Go, Java, etc.)

  • Native C/C++ Libraries: The importer will not import a package that isn't distributed through a supported package manager, e.g., pcsc-lite.

  • Invalid CPE Strings: The importer will not import a package where file paths or other non-CPE values are specified in the CPE field.

Supported Vendors by Ecosystem

Ecosystem

Supported CPE vendors

Example

Maven (Java)

apache, oracle, eclipse, spring, springframework, pivotal, pivotal_software, jcraft, maven_package

cpe:2.3:a:apache:log4j:2.14.1:*:*:*:*:*:*:*

Go

golang, golang_package, hashicorp, docker, gorm, dvsekhvalnov, go-proxyproto_project, fasthttp_project

cpe:2.3:a:golang:crypto:0.19.0:*:*:*:*:*:*:*

PyPI (Python)

python, python_software_foundation, pypi

cpe:2.3:a:python:flask:2.0.0:*:*:*:*:*:*:*

npm (Node.js)

npmjs, nodejs, node.js

cpe:2.3:a:npmjs:lodash:4.17.21:*:*:*:*:*:*:*

NuGet (.NET)

nuget

cpe:2.3:a:nuget:newtonsoft.json:13.0.1:*:*:*:*:*:*:*

Gem (Ruby)

rubygems, rubyonrails, ruby-lang

cpe:2.3:a:rubygems:rails:7.0.0:*:*:*:*:*:*:*

Rust

rust-lang

cpe:2.3:a:rust-lang:rust:1.65.0:*:*:*:*:*:*:*

Composer (PHP)

packagist

cpe:2.3:a:packagist:laravel:9.0.0:*:*:*:*:*:*:*

Deb (Debian/Ubuntu)

debian, debian_package, ubuntu

cpe:2.3:a:debian:openssl:1.1.1:*:*:*:*:*:*:*

RPM (Red Hat/Fedora)

redhat, fedoraproject, centos

cpe:2.3:a:redhat:openssl:1.1.1:*:*:*:*:*:*:*

APK (Alpine)

alpine

cpe:2.3:a:alpine:busybox:1.35.0:*:*:*:*:*:*:*

Prerequisites

  • Only users with the Product Admin or Organization Admin role can access the product’s Configuration Page and upload a previously generated SBOM file.

Getting it done

Create a new Project by Uploading an SBOM File via the Add Project Wizard

To create a new project out of an existing SBOM file, you will need the relevant Product Admin (or an Organization Admin) to upload the SBOM file to the product in which you would like the new project created, via the Product Configuration Page. Here’s how to do it:

  1. Navigate to the Products menu and select the product in which you would like to create the new project:

    image-20240926-170006.png

  2. On the product page, click the “Add Project” button:

    image-20240926-165614.png

  3. A. In the Project Details wizard, specify a Project Name and Description.
    B. Check the “Import SBOM” box, to reveal the option to upload an SBOM file.
    C. Click “Choose File” to browse your file system and select the desired SBOM file which meets the required specifications.

    image-20240926-191252.png

  4. Click the “Create” button (image-20240926-171135.png) located at the bottom-right corner of the wizard.

At this stage, you may see a “Background process in progress” message at the top of the project page, indicating that the new project is being set up.

image-20240926-191828.png

Update an Existing Project by Uploading an SBOM File via the Project Administration Screen

To import an SBOM report, you will need the relevant Product Admin (or an Organization Admin) to upload the SBOM file to the SCA application via the Project Administration page:

  1. Find your project in the Projects menu and click it:

    image-20240927-143943.png

    Alternatively, you can navigate to the relevant product and locate the project under “Project Summary”.

  2. Clicking the cogwheel button (image-20240923-182605.png) at the far right will take you to the Project Administration page.

  3. Click “Update Project”:

    image-20240923-182720.png
  4. In the Update Project window, click “Choose File” to browse your file system for the SBOM file. Click “Update” to upload the selected file.

    image-20240923-183154.png

Note: The SBOM import will override the project’s existing inventory.

Compare your SBOMs

A common use case following the SBOM import process is to compare projects, e.g., comparing different versions of a project represented through SBOM files. This comparison helps in identifying changes in dependencies, vulnerabilities, and licensing information across project versions.

Mend.io recommends using the existing “Project Comparison” capability, to compare different projects' inventories and licenses.

On the project page, click the “Compare to another Project” button:

image-20240927-110154.png

That will take you to the Project Comparison screen, allowing you to select the two projects you wish to compare.

Note that the Licensing Occurrences table on the right lists license differences, which may be handy, for example in case you wish to identify unwanted licenses added/removed in the new version of your project:

image-20240927-110811.png

Limitations

  1. Source libraries in SBOM Export files generated by Mend.io are ignored.

  2. Keywords support limitations:

    • For SPDX, Mend.io supports the properties below:

      CODE
      "DEPENDS_ON", 
      "DYNAMIC_LINK", 
      "STATIC_LINK", 
      "CONTAINS", 
      "DESCRIBE"
    • For CycloneDX, Mend.io supports the “dependsOn” property.
      Example:

      CODE
      "ref": "pkg:maven/com.google.apis/google-api-services-ml@v1-rev20210212-1.31.0?type=jar", 
      "dependsOn": [ "pkg:maven/com.google.api-client/google-api-client@1.31.1?type=jar" ]
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.