Quick Start Guide
Using the Red Hat Trusted Profile Analyzer managed service on Red Hat Hybrid Cloud Console
Abstract
Preface
Welcome to the Red Hat Trusted Profile Analyzer (RHTPA) Quick Start Guide!
This is a quick start guide on how to use the Trusted Profile Analyzer managed service on Red Hat’s Hybrid Cloud Console.
Chapter 1. Searching for vulnerability information
You can use the Trusted Profile Analyzer service to find existing Software Bill of Materials (SBOM), Vulnerability Exploitability eXchange (VEX) documents, and common vulnerability and exposure (CVE) information for Red Hat products and packages.
Trusted Profile Analyzer managed service provides only information for the following Red Hat products:
- Red Hat Enterprise Linux Universal Base Image (UBI) versions 8 and 9.
- The Java Quarkus library.
Prerequisites
- A Red Hat user account to access the Red Hat Hybrid Cloud Console.
Procedure
- Open a web browser.
- Go to the Application and Data Services home page on the Hybrid Cloud Console.
- If prompted, log in to the Hybrid Cloud Console with your credentials.
- On the navigation menu, click Trusted Profile Analyzer.
On the Trusted Profile Analyzer home page, click the Subscribe and launch button. A new web browser window opens to the Trusted Profile Analyzer console home page.
NoteBy subscribing, your registered email address goes onto the product mailing list, so you can receive information about new product developments.
- On the Home page, in the search field, enter your search criteria and click Search.
On the search results page, you can filter the results by Red Hat products, download SBOM files, view package vulnerability information, and view any possible remediations.
NoteThe number shown on the Advisories tab is how many times your search criteria made a match. On the Products and containers tab, the number in the Product advisories column shows the number of advisories for that specific product.
Chapter 2. Scanning a software bill of materials file
You can scan your custom software bill of materials (SBOM) manifest files for analysis by Red Hat.
Red Hat does not retain a copy of your scanned SBOM files.
Prerequisites
- A Red Hat user account to access the Red Hat Hybrid Cloud Console.
- An existing CycloneDX 1.3, 1.4, or 1.5 or Software Package Data Exchange (SPDX) 2.2, 2.3 manifest files.
Procedure
- Open a web browser.
- Go to the Application and Data Services home page on the Hybrid Cloud Console.
- If prompted, log in to the Hybrid Cloud Console with your credentials.
- On the navigation menu, click Trusted Profile Analyzer.
On the Trusted Profile Analyzer home page, click the Subscribe and launch button. A new web browser window opens to the Trusted Profile Analyzer console home page.
NoteBy subscribing, your registered email address goes onto the product mailing list, so you can receive information about new product developments.
- Click Scan SBOM from the navigation menu.
- You can drag-and-drop an SBOM manifest file onto the page, or click Load an SBOM.
- After scanning the SBOM file, you get a summary of the analysis, and specific vulnerability information for the packages included in your SBOM file.
Additional resources
- To learn how to create a software bill of materials file, see the Trusted Profile Analyzer Reference Guide for details.
Chapter 3. Configuring Visual Studio Code to use Dependency Analytics
You can gain access to Red Hat’s Trusted Profile Analyzer service by using the Dependency Analytics extension for Microsoft’s Visual Studio Code (VS Code) editor application. With this extension you get access to the latest open source vulnerability information, and insights about your application’s dependent packages. The Red Hat Dependency Analytics extension uses the following data sources for the most up-to-date vulnerability information available:
- The ONGuard service, integrates the Open Source Vulnerability (OSV) and the National Vulnerability Database (NVD) data sources. When given a set of packages to the ONGuard service, a query to OSV retrieves the associated vulnerability information, and then a query to NVD for public Common Vulnerability and Exposures (CVE) information.
Dependency Analytics supports the following programming languages:
- Maven
- Node
- Python
- Go
Visual Studio Code by default, executes binaries directly in a terminal found in your system’s PATH
environment. You can configure Visual Studio Code to look somewhere else to run the necessary binaries. You can configure this by accessing the extension settings. Click the Workspace tab, search for the word executable, and specify the absolute path to the binary file you want to use for Maven, Node, Python, or Go.
The Dependency Analytics extension is an online service maintained by Red Hat. Dependency Analytics only accesses your manifest files to analyze your application dependencies before displaying the results.
Prerequisites
- Install Visual Studio Code on your workstation.
-
For Maven projects, analyzing a
pom.xml
file, you must have themvn
binary in your system’sPATH
environment. -
For Node projects, analyzing a
package.json
file, you must have thenpm
binary in your system’sPATH
environment. -
For Go projects, analyzing a
go.mod
file, you must have thego
binary in your system’sPATH
environment. -
For Python projects, analyzing a
requirements.txt
file, you must have thepython3/pip3
orpython/pip
binaries in your system’sPATH
environment. Also, the Python application needs to be in VS Code’s interpreter path.
Procedure
- Open the Visual Studio Code application.
- From the file menu, click View, and click Extensions.
- Search the Marketplace for Red Hat Dependency Analytics.
- Click the Install button to install the extension. Wait for the installation to finish.
To start scanning your application for security vulnerabilities, and view the vulnerability report, you can do one of the following:
- Open a manifest file, hover over a dependency marked by the inline Component Analysis, indicated by the wavy-red line under a dependency name, click Quick Fix, and click Detailed Vulnerability Report.
- Open a manifest file, and click the pie chart icon.
- Right click on a manifest file in the Explorer view, and click Red Hat Dependency Analytics Report….
- From the vulnerability pop-up alert message, click Open detailed vulnerability report.
Additional resources
- Red Hat Dependency Analytics Visual Studio marketplace page.
- The GitHub project.
Chapter 4. Configuring IntelliJ to use Dependency Analytics
You can gain access to Red Hat’s Trusted Profile Analyzer service by using the Dependency Analytics plugin for Jet Brains' IntelliJ IDEA application. With this plugin you get access to the latest open source vulnerability information, and insights about your application’s dependent packages. The Red Hat Dependency Analytics plugin uses the following data sources for the most up-to-date vulnerability information available:
- The ONGuard service, integrates the Open Source Vulnerability (OSV) and the National Vulnerability Database (NVD) data sources. When given a set of packages to the ONGuard service, a query to OSV retrieves the associated vulnerability information, and then a query to NVD for public Common Vulnerability and Exposures (CVE) information.
Dependency Analytics supports the following programming languages:
- Maven
- Node
- Python
- Go
The Dependency Analytics extension is an online service maintained by Red Hat. Dependency Analytics only accesses your manifest files to analyze your application dependencies before displaying the results.
Prerequisites
- Install IntelliJ IDEA on your workstation.
-
For Maven projects, analyzing a
pom.xml
file, you must have themvn
binary in your system’sPATH
environment. -
For Node projects, analyzing a
package.json
file, you must have thenpm
binary in your system’sPATH
environment. -
For Go projects, analyzing a
go.mod
file, you must have thego
binary in your system’sPATH
environment. -
For Python projects, analyzing a
requirements.txt
file, you must have thepython3/pip3
orpython/pip
binaries in your system’sPATH
environment.
Procedure
- Open the IntelliJ application.
- From the file menu, click Settings , and click Plugins.
- Search the Marketplace for Red Hat Dependency Analytics.
- Click the INSTALL button to install the plug-in.
To start scanning your application for security vulnerabilities, and view the vulnerability report, you can do one of the following:
- Open a manifest file, hover over a dependency marked by the inline Component Analysis, indicated by the wavy-red line under a dependency, and click Detailed Vulnerability Report.
- Right click on a manifest file in the Project window, and click Dependency Analytics Report.
Additional resources
- Red Hat’s Dependency Analytics Jet Brains marketplace page.
- The GitHub project.