このコンテンツは選択した言語では利用できません。
Chapter 3. Configuring Visual Studio Code to use Dependency Analytics
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 following programming languages:
- Maven
Gradle
- Groovy
- Kotlin DSL
- NPM
- PNPM
Yarn
- Berry
- Classic
- 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.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.
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