此内容没有您所选择的语言版本。
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 the Red Hat Hybrid Cloud Console.
Chapter 1. Searching for vulnerability information 复制链接链接已复制到粘贴板!
You can use the Trusted Profile Analyzer managed service to find existing Software Bill of Materials (SBOM) documents, Vulnerability Exploitability eXchange (VEX) documents, license information, and common vulnerability and exposure (CVE) information, along advisory information for Red Hat products and software 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 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.
- A new web browser window opens to the Trusted Profile Analyzer console home page. From the Trusted Profile Analyzer home page, on the navigational menu, click Search.
- Enter your search criteria into the dialog box to begin your search.
On the search results page, you can filter the results by Red Hat products, download SBOM files, view package vulnerability and advisory information, along with any possible remediations.
NoteThe number shown on the Advisories tab is how many times your search criteria made a match.
Chapter 2. Scanning a software bill of materials file 复制链接链接已复制到粘贴板!
You can scan software bill of materials (SBOM) documents using the Red Hat Trusted Profile Analyzer service on Hybrid Cloud Console or your own {acronym} instance. The Trusted Profile Analyzer service can analyze a standard SBOM, Artificial Intelligence Bill of Materials (AIBOM) containing language models, and Cryptographic Bill of Materials (CBOM) containing keys, certificates, and libraries.
Red Hat does not retain a copy of your scanned SBOM documents.
Prerequisites
- A Red Hat user account to access the Red Hat Hybrid Cloud Console.
- An existing CycloneDX 1.3, 1.4, 1.5, 1.6 or Software Package Data Exchange (SPDX) 2.2, 2.3 document files.
Procedure
- Open a web browser.
- Go to the Application 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.
- A new web browser window opens to the Trusted Profile Analyzer console home page.
- Click SBOMs from the navigation menu.
- Click the Generate vulnerability report button.
- You can drag and drop your SBOM file directly to this page, or click the Browse Files button, then choose the SBOM file you want to scan.
- After {acronym} scans the SBOM file, you get a summary of the analysis, and any specific vulnerability information for the packages included in your SBOM file.
You can gain access to Red Hat’s Trusted Profile Analyzer (RHTPA) service by using the Dependency Analytics extension for Microsoft’s Visual Studio Code application. With this extension you get access to the latest open source vulnerability information, and insights about your application’s dependent packages.
Dependency Analytics supports the analysis of Dockerfiles, and the following package managers:
- Maven
Gradle
- Groovy DSL
- Kotlin DSL
- NPM
- PNPM
Yarn
- Berry
- Classic
- Python PIP
- Go mod
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 Dockerfiles, the
syftbinary must be in your system’sPATHenvironment. -
For Maven projects, analyzing a
pom.xmlfile, you must have themvnbinary in your system’sPATHenvironment. -
For NPM projects, analyzing a
package.jsonfile, you must have thenpmbinary in your system’sPATHenvironment. -
For Go projects, analyzing a
go.modfile, you must have thegobinary in your system’sPATHenvironment. -
For Python projects, analyzing a
requirements.txtfile, you must have thepython3/pip3orpython/pipbinaries in your system’sPATHenvironment. Also, the Python application needs to be in VS Code’s interpreter path. -
For Gradle projects, analyzing a
build.gradlefile for Groovy DSL, or abuild.gradle.ktsfile for Kotlin DSL.
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 the 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.
If you want to exclude specific packages for analysis, you can use the
exhortignoreas a comment tag for your specific programming language.For Maven, update the
pom.xmlfile:Copy to Clipboard Copied! Toggle word wrap Toggle overflow For Go, update the
go.modfile:Copy to Clipboard Copied! Toggle word wrap Toggle overflow For Python, update the
requirements.txtfile:... click==8.0.4 #exhortignore ...
... click==8.0.4 #exhortignore ...Copy to Clipboard Copied! Toggle word wrap Toggle overflow For Gradle, update the
build.gradlefile:Copy to Clipboard Copied! Toggle word wrap Toggle overflow
You can gain access to Red Hat’s Trusted Profile Analyzer service by using the Dependency Analytics plugin for Jet Brains' IntelliJ IDEA application. This plugin gives you access to the latest open source vulnerability information, and insights about your application’s dependent packages.
Dependency Analytics supports the analysis of Dockerfiles, and the following package managers:
- Maven
Gradle
- Groovy DSL
- Kotlin DSL
- NPM
- PNPM
Yarn
- Berry
- Classic
- Python PIP
- Go mod
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 Dockerfiles, the
syftbinary must be in your system’sPATHenvironment. -
For Maven projects, analyzing a
pom.xmlfile, you must have themvnbinary in your system’sPATHenvironment. -
For Node projects, analyzing a
package.jsonfile, you must have thenpmbinary in your system’sPATHenvironment. -
For Go projects, analyzing a
go.modfile, you must have thegobinary in your system’sPATHenvironment. -
For Python projects, analyzing a
requirements.txtfile, you must have thepython3/pip3orpython/pipbinaries in your system’sPATHenvironment. -
For Gradle projects, analyzing a
build.gradlefile for Groovy DSL, or abuild.gradle.ktsfile for Kotlin DSL.
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 plugin.
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 the manifest file in the Project window, and click Dependency Analytics Report.
If you want to exclude specific packages for analysis, you can use the
exhortignoreas a comment tag for your specific programming language.For Maven, update the
pom.xmlfile:Copy to Clipboard Copied! Toggle word wrap Toggle overflow For Go, update the
go.modfile:Copy to Clipboard Copied! Toggle word wrap Toggle overflow For Python, update the
requirements.txtfile:... click==8.0.4 #exhortignore ...
... click==8.0.4 #exhortignore ...Copy to Clipboard Copied! Toggle word wrap Toggle overflow For Gradle, update the
build.gradlefile:Copy to Clipboard Copied! Toggle word wrap Toggle overflow