Reference Guide
Additional reference information for Red Hat Trusted Profile Analyzer
Abstract
Preface Copy linkLink copied to clipboard!
Welcome to the Red Hat Trusted Profile Analyzer (RHTPA) Reference Guide!
In this guide you can find general reference material regarding the Trusted Profile Analyzer service.
Chapter 1. Creating a software bill of materials manifest file Copy linkLink copied to clipboard!
Red Hat Trusted Profile Analyzer can analyze both CycloneDX and Software Package Data Exchange (SPDX) SBOM formats by using the JSON file format. Many open source tools are available to you for creating Software Bill of Materials (SBOM) manifest files from container images, or for your application. For this procedure we are going to use the Syft tool.
Currently, Trusted Profile Analyzer only supports CycloneDX version 1.3, 1.4, and 1.5, along with SPDX version 2.2, and 2.3.
Prerequisites
Install Syft for your workstation platform:
Procedure
To create an SBOM by using a container image.
CycloneDX format:
Syntax
syft IMAGE_PATH -o cyclonedx-json@1.5
syft IMAGE_PATH -o cyclonedx-json@1.5
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Example
syft registry:example.io/hello-world:latest -o cyclonedx-json@1.5
$ syft registry:example.io/hello-world:latest -o cyclonedx-json@1.5
Copy to Clipboard Copied! Toggle word wrap Toggle overflow SPDX format:
Syntax
syft IMAGE_PATH -o spdx-json@2.3
syft IMAGE_PATH -o spdx-json@2.3
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Example
syft registry:example.io/hello-world:latest -o spdx-json@2.3
$ syft registry:example.io/hello-world:latest -o spdx-json@2.3
Copy to Clipboard Copied! Toggle word wrap Toggle overflow NoteSyft supports many types of container image sources. See the official supported source list on Syft’s GitHub site.
To create an SBOM by scanning the local file system.
CycloneDX format:
Syntax
syft dir: DIRECTORY_PATH -o cyclonedx-json@1.5 syft file: FILE_PATH -o cyclonedx-json@1.5
syft dir: DIRECTORY_PATH -o cyclonedx-json@1.5 syft file: FILE_PATH -o cyclonedx-json@1.5
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Example
syft dir:. -o cyclonedx-json@1.5 syft file:/example-binary -o cyclonedx-json@1.5
$ syft dir:. -o cyclonedx-json@1.5 $ syft file:/example-binary -o cyclonedx-json@1.5
Copy to Clipboard Copied! Toggle word wrap Toggle overflow SPDX format:
Syntax
syft dir: DIRECTORY_PATH -o spdx-json@2.3 syft file: FILE_PATH -o spdx-json@2.3
syft dir: DIRECTORY_PATH -o spdx-json@2.3 syft file: FILE_PATH -o spdx-json@2.3
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Example
syft dir:. -o spdx-json@2.3 syft file:/example-binary -o spdx-json@2.3
$ syft dir:. -o spdx-json@2.3 $ syft file:/example-binary -o spdx-json@2.3
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Chapter 2. Downloading and viewing license information Copy linkLink copied to clipboard!
Red Hat’s Trusted Profile Analyzer (RHTPA) can analyze both CycloneDX and Software Package Data Exchange (SPDX) SBOM documents. You can download and view license information from uploaded Software Bill of Materials (SBOM) documents, in CycloneDX or SPDX format. To learn more about the differences between the two licenses formats for CycloneDX and SPDX, see the additional resources section.
Prerequisites
- Installation of RHTPA service on Red Hat OpenShift or Red Hat Enterprise Linux.
- An uploaded CycloneDX 1.3, 1.4, or 1.5 or SPDX 2.2, 2.3 document.
Procedure
- Open a web browser, and log in to the RHTPA console.
- From the home page, click Search from the navigational sidebar.
- Find your SBOM from the list.
- Click the dropdown menu, and click Download License Export.
-
Extract the license information from the downloaded
.zip
file. Open the comma-separated values (CSV) file to view it.
NoteThe license reference CSV file only applies to SPDX-formatted SBOMs.
Chapter 3. Frequently asked questions Copy linkLink copied to clipboard!
Do you have questions about Red Hat’s Trusted Profile Analyzer product and service? Here is a collection of common questions and their answers to help you understand more about Red Hat’s Trusted Profile Analyzer product and service.
- Q: What is Red Hat’s Trusted Profile Analyzer?
- Q: What is Red Hat’s Trusted Profile Analyzer service?
- Q: What are the benefits of using Red Hat Trusted Profile Analyzer?
- Q: Who should use Red Hat’s Trusted Profile Analyzer?
- Q: What problems does Trusted Profile Analyzer solve?
- Q: How does Trusted Profile Analyzer help with SBOM management and analysis?
- Q: How does Red Hat use Trusted Profile Analyzer?
- Q: What types of SBOMs can RHTPA analyze?
- Q: What SBOM formats does RHTPA accept?
- Q: How does it integrate into the development workflow?
- Q: What types of deployment are supported?
- Q: Where can I learn more or get started?
What is Red Hat’s Trusted Profile Analyzer?
Red Hat Trusted Profile Analyzer is a product within the Red Hat Trusted Software Supply Chain suite that helps organizations manage and analyze their Software Bills of Materials (SBOMs), vendor VEX (Vulnerability Exploitability eXchange), and CVE (Common Vulnerabilities and Exposures) information. It empowers security, developers and DevSecOps teams to assess risk profiles across custom, third-party, and open source software components without slowing down development or increasing operational complexity.
What is Red Hat’s Trusted Profile Analyzer service?
Red Hat’s Trusted Profile Analyzer service provides an application risk profile by analyzing your application’s SBOM for security and vulnerability risks of Open Source Software (OSS) dependencies. The RHTPA service has vulnerability information from CVE aggregators and Red Hat Security Advisories.
The Trusted Profile Analyzer service is a hosted instance on Red Hat’s Hybrid Cloud Console. You can use this service, free of charge, to assess the risk profile of your SBOM by uploading it directly to the service. Red Hat does not keep a copy of your SBOM.
What are the benefits of using Red Hat Trusted Profile Analyzer?
- Enhanced transparency throughout the software supply chain.
- Early detection and remediation of vulnerabilities.
- Centralized management of SBOMs, VEX, and CVE data.
- Reduced risk of introducing security flaws into production environments.
- Improved compliance with industry standards for software security.
Who should use Red Hat’s Trusted Profile Analyzer?
Red Hat Trusted Profile Analyzer is ideal for organizations and teams involved in software development, security, and operations (DevSecOps) who need to manage and secure their software supply chain, especially software that uses open source and third-party components.
What problems does Trusted Profile Analyzer solve?
Red Hat Trusted Profile Analyzer addresses the need for transparency and security in software supply chains by enabling organizations to:
- Manage SBOMs and vulnerability remediation information efficiently.
- Stay informed about vulnerabilities in open source software, and proprietary codebases across software inventories.
- Eliminate vulnerabilities early in the development process.
- Analyze and expose license information.
- Ensure regulatory compliance.
How does Trusted Profile Analyzer help with SBOM management and analysis?
Trusted Profile Analyzer provides storage and management for SBOMs creating a software inventory, allowing organizations to support a comprehensive record of software components from in-house applications, and third party vendors. Trusted Profile Analyzer supports cross-referencing components within an SBOMs with CVEs and Common Security Advisory Framework (CSAF) VEX security advisories, and providing an application risk profile ensuring transparency in the software supply chain.
How does Red Hat use Trusted Profile Analyzer?
Trusted Profile Analyzer is an important part of Red Hat’s internal software supply chain. It provides Red Hat with a source of truth for SBOM storage, risk profiling, and analysis.
What types of SBOMs can RHTPA analyze?
Trusted Profile Analyzer can analyze SBOMs created directly from source code, generated during the build process, or generated by the analysis of artifacts, such as containers and packages.
What SBOM formats does RHTPA accept?
Trusted Profile Analyzer supports SBOMs formatted in CycloneDX 1.6 or lower, and SPDX 2.3 or lower.
How does it integrate into the development workflow?
Integrating RHTPA into your CI/CD pipeline is as easy as adding a task for SBOM generation, and upload it to the Trusted Profile Analyzer service.
What types of deployment are supported?
You can deploy RHTPA on Red Hat Enterprise Linux or Red Hat Openshift Container Platform. See the RHTPA Deployment Guide for more details.
Where can I learn more or get started?
Visit the Red Hat Trusted Profile Analyzer overview page on Red Hat Developers for more information, documentation, and resources to help you get started.
Chapter 4. Glossary Copy linkLink copied to clipboard!
Common terms and definitions for Red Hat’s Trusted Profile Analyzer service.
- Exhort
- The backend endpoint of Trusted Profile Analyzer where all the API requests get sent, to retrieve the necessary data to analyze, including package dependencies and vulnerabilities. The Red Hat Dependency Analytics (RHDA) integrated development environment (IDE) plug-in uses this endpoint to generate vulnerability reports within the IDE framework.
- Software Bill of Materials
- Also known by the acronym, SBOM. A manifest of dependent software packages needed for a particular application.
- Single Pane of Glass
- Also known by the acronym, SPOG. The RESTful application programming interface (API) for the Trusted Profile Analyzer web dashboard, and notifications.
- Vulnerability Exploitability eXchange
- Also known by the acronym, VEX. A security advisory issued by a software provider for specific vulnerabilities within a product.
- Common Vulnerability and Exposures
- Also known by the acronym, CVE. A CVE indicates a product’s exposure to attacks and malicious activities by giving it a score 1-10, where 1 is the lowest exposure level and 10 is the highest exposure level.
- Common Vulnerability Score System
- Also known by the acronym CVSS. The CVSS calculates CVE scores according to specific formulas when trying to calculate CVEs in a broad range of products and networks.