estebandugueperoux2 / jfrog-vscode-extension

JFrog VS-Code Extension

JFrog Extension for VS Code & Eclipse Theia

Table of Contents

• About this Extension
• Getting Started
  • Install the JFrog extension in VS Code
  • Connecting VS Code to Your JFrog Environment
  • Using the extension
    • Severity Icons
• The Local View
  • Scanning Workspace
  • Viewing Vulnerabilities
    • Viewing Vulnerability Details
  • Updating Dependencies
  • Ignore Rules
  • Behind the Scenes
    • Go Projects
    • Maven Projects
    • Npm Projects
      • Exclude Development Dependencies During Scan
    • Yarn v1 Projects
    • Pypi Projects
    • .NET Projects
• The CI View
  • How Does It Work?
  • Setting Up Your CI Pipeline
  • Setting Up the CI View
• Extension Settings
  • Apply Xray Policies to your Projects
  • Exclude Paths from Scan
  • Proxy Configuration
  • Proxy Authorization
    • Basic authorization
    • Access token authorization
    • Example
• Troubleshooting
• License
• Building and Testing the Sources
  • Preconditions
• Code Contributions
  • Guidelines

About this Extension

The cost of remediating a vulnerability is akin to the cost of fixing a bug. The earlier you remediate a vulnerability in the release cycle, the lower the cost. The extension allows developers to find and fix security vulnerabilities in their projects and to see valuable information about the status of their code by continuously scanning it locally with JFrog Xray.

What security capabilities do we provide?

Software Composition Analysis (SCA)

Scan your project dependencies for security issues. For selected security issues, get leverage-enhanced CVE data that is provided by our JFrog Security Research team. To learn more about enriched CVEs, see here

Advanced Scans

Requires Xray version 3.66.5 or above and Enterprise X / Enterprise+ subscription with Advanced DevSecOps.

With advanced Contextual Analysis, understand the applicability of CVEs in your application and utilize JFrog Security scanners to analyze the way you use 3rd party packages in your projects. Automatically validate some high-impact vulnerabilities, such as vulnerabilities that have prerequisites for exploitations, and reduce false positives and vulnerability noise with smart CVE analysis.

To learn more, see here.

Supported Packages

Features	Go	Maven	npm	Yarn v1	Pypi	.NET
SCA	✅	✅	✅	✅	✅	✅
Upgrade vulnerable dependencies to fixed versions	✅	✅	✅	✅	✅	✅
Contextual Analysis	❌	❌	✅	✅	✅	❌
Exclude dev dependencies	❌	❌	✅	❌	❌	❌

Additional Perks

• Security issues are easily visible inline.
• The results show issues with context, impact, and remediation.
• View all security issues in one place, in the JFrog tab.
• For Security issues with an available fixed version, you can upgrade to the fixed version within the plugin.
• Track the status of the code while it is being built, tested, and scanned on the CI server.

The extension also applies JFrog File Spec JSON schema on the following file patterns: **/filespecs/*.json, *filespec*.json and *.filespec. Read more about JFrog File specs here.

Getting Started

1. Install the JFrog extension in VS Code
2. Connect VS Code to Your JFrog Environment
3. Start using the extension

Install the JFrog extension in VS Code

The extension is available to install from the VS Code extensions marketplace. after installing the JFrog extension tab will appear in the activity bar

Connecting VS Code to Your JFrog Environment

If you don't have a JFrog Platform instance, create a free instance in the cloud by running one of the following commands in your terminal.

MacOS and Linux using cUrl

curl -fL "https://getcli.jfrog.io?setup" | sh

Windows using PowerShell

powershell "Start-Process -Wait -Verb RunAs powershell '-NoProfile iwr https://releases.jfrog.io/artifactory/jfrog-cli/v2-jf/[RELEASE]/jfrog-cli-windows-amd64/jf.exe -OutFile $env:SYSTEMROOT\system32\jf.exe'" ; jf setup

The commands will do the following:

1. Install JFrog CLI on your machine.
2. Create a FREE JFrog environment in the cloud for you.
3. Configure VS Code to connect to your new environment.

Connect VS Code to your JFrog Platform instance by clicking on the green Connect button or the provided button in the JFrog extension tab:

You can choose one of the following methods to provide VS Code with the JFrog Platform connections details.

Use the JFrog CLI Credentials

If JFrog CLI is installed on your machibe, and is configured with the JFrog Platform's connection details, use those details to connect VS Code to the JFrog Platform.

Enter Connection

Enter your JFrog platform connection details manually.

Note: You can leave the JFrog Platform URL empty, to enter the URLs of Artifactory and Xray separately.

Environment Variables

You may set the connection details using the following environment variables. VS Code will read them after it is launched.

• JFROG_IDE_URL - JFrog URL
• JFROG_IDE_USERNAME - JFrog username
• JFROG_IDE_PASSWORD - JFrog password
• JFROG_IDE_ACCESS_TOKEN - JFrog access token
• JFROG_IDE_STORE_CONNECTION - Set the value of this environment variable to true, if you'd like VS Code to store the connection details after reading them from the environment variables.

Note: For security reasons, it is recommended to unset the environment variables after launching VS Code.

Using the Extension

The extension offers two modes, Local and CI. The two modes can be toggled by pressing on their respective buttons that will appear next to the components tree.

• The Local view displays information about the local code as it is being developed in VS Code. The developer can scan their local workspace continuously. The information is displayed in the Local view.
• The CI view allows the tracking of the code as it is built, tested and scanned by the CI server. It displays information about the status of the build and includes a link to the build log on the CI server.

Severity Icons

The icon demonstrates the top severity issue of a selected component and its transitive dependencies. The following table describes the severities from highest to lowest:

Icon	Severity	Description
	Critical	Issue with critical severity
	High	Issue with high severity
	Medium	Issue with medium severity
	Low	Issue with low severity
	Unknown	Issue with unknown severity
	Not Applicable	CVE issue that is not applicable to your source code
	Normal	No issues (Used only in CI view)

The Local View

The local view of the extension adds JFrog Xray scanning of project dependencies and source code to your VS Code IDE. It allows developers to view panels displaying vulnerability information about their dependencies and source code in their VS Code IDE. With this information, a developer can make an informed decision on whether to use a component or not before it gets entrenched into the organization’s product.

Scanning workspace

scan your workspace by clicking the Scan/Rescan button, the icon at the extension tab or click on Start Xray Scan from within the editor. The scan will create a list of files with vulnerabilities in the workspace.

Viewing vulnerabilities

View all the discovered files with vulnerabilities in a tree. Each descriptor file (like pom.xml in Maven, go.mod in Go, etc.) in the list contains vulnerable dependencies, and each dependency contains the vulnerabilities themselves. Other source code files contains a list of vulnerabilities for each location at the file. In addition the locations with vulnerabilities will be marked in the editor and you can jump from vulnerable location in the editor to the matching entry at the tree by clicking on th light bulb.

Viewing Vulnerability Details

Clicking a vulnerability in the list will open the location with the issue in the editor and a vulnerability details view. This view contains information about the vulnerability, the vulnerable component, fixed versions, impact paths and much more.

CVE Research and Enrichment

For selected security issues, get leverage-enhanced CVE data that is provided by our JFrog Security Research team. Prioritize the CVEs based on:

• JFrog Severity: The severity given by the JFrog Security Research team after the manual analysis of the CVE by the team. CVEs with the highest JFrog security severity are the most likely to be used by real-world attackers. This means that you should put effort into fixing them as soon as possible.
• Research Summary: The summary that is based on JFrog's security analysis of the security issue provides detailed technical information on the specific conditions for the CVE to be applicable. Remediation: Detailed fix and mitigation options for the CVEs

Check out what our research team is up to and stay updated on newly discovered issues by clicking on this link.

Contextual Analysis

Xray automatically validates some high and very high impact vulnerabilities, such as vulnerabilities that have prerequisites for exploitations, and provides contextual analysis information for these vulnerabilities, to assist you in figuring out which vulnerabilities need to be fixed. Contextual Analysis data includes:

• Contextual analysis status: Contextual analysis results indicating if a CVE was found applicable in your application or not applicable.
• Contextual Analysis breakdown: An explanation provided by our research team as to why the CVE was found applicable or not applicable.
• Remediation: Contextual mitigation steps and options provided by our research team that assist you with remediating the issues.

Updating Dependencies

Update a vulnerable direct dependency to a fixed version directly from the vulnerable location at the editor using quick fix

Ignore Rules

If Xray watches are used, on an icon vulnerability line an closed eye icon will appear by clicking on it you can create an Ignore Rule in Xray.

Behind the Scenes

Go Projects

Behind the scenes, the JFrog VS Code Extension scans all the project dependencies, both direct and indirect (transitive), even if they are not declared in the project's go.mod. It builds the Go dependencies tree by running go mod graph and intersecting the results with go list -f '{{with .Module}}{{.Path}} {{.Version}}{{end}}' all command. Therefore, please make sure to have Go CLI in your system PATH.

Maven Projects

The JFrog VS Code Extension builds the Maven dependencies tree by running mvn dependency:tree. View licenses and top issue severities directly from the pom.xml.

Important notes:

1. To have your project dependencies scanned by JFrog Xray, make sure Maven is installed, and that the mvn command is in your system PATH.
2. For projects which include the Maven Dependency Plugin as a build plugin, with include or exclude configurations, the scanning functionality is disabled. For example:

      <plugins>
        <plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-dependency-plugin</artifactId>
          <configuration>
            <includes>org.apache.*</includes>
          </configuration>
        </plugin>
      </plugins>

Npm Projects

Behind the scenes, the extension builds the npm dependencies tree by running npm list. View licenses and top issue severities directly from the package.json.

Important: To have your project dependencies scanned by JFrog Xray, make sure the npm CLI is installed on your local machine and that it is in your system PATH. In addition, the project dependencies must be installed using npm install.

Exclude Development Dependencies During Scan

Development dependencies are scanned by default. You can exclude them by choosing Exclude Dev Dependencies in the Extension Settings. Currently, only npm is supported.

Yarn v1 Projects

Behind the scenes, the extension builds the Yarn dependencies tree by running yarn list. View licenses and top issue severities directly from the yarn.lock.

Important:

• To have your project dependencies scanned by JFrog Xray, make sure the Yarn CLI is installed on your local machine and that it is in your system PATH.
• Yarn v2 is not yet supported.

Pypi Projects

Behind the scenes, the extension builds the Pypi dependencies tree by running pipdeptree on your Python virtual environment. It also uses the Python interpreter path configured by the Python extension. View licenses and top issue severities directly from your requirements.txt files. The scan your Pypi dependencies, make sure the following requirements are met:

1. The Python extension for VS Code is installed.

2. Depending on your project, Please make sure Python 2 or 3 are included in your system PATH.

3. Create and activate a virtual env as instructed in VS-Code documentation. Make sure that Virtualenv Python interpreter is selected as instructed here.

4. Open a new terminal and activate your Virtualenv:

   • On macOS and Linux:

     source <venv-dir>/bin/activate
     
     # For example:
     source .env/bin/activate

   • On Windows:

     .\<venv-dir>\Scripts\activate
     
     # For example:
     .\env\Scripts\activate

5. In the same terminal, install your python project and dependencies according to your project specifications.

.NET Projects

For .NET projects which use NuGet packages as dependencies, the extension displays the NuGet dependencies tree, together with the information for each dependency. Behind the scenes, the extension builds the NuGet dependencies tree using the NuGet deps tree npm package.

Important:

• Does your project define its NuGet dependencies using a packages.config file? If so, then please make sure the nuget CLI is installed on your local machine and that it is in your system PATH. The extension uses the nuget CLI to find the location of the NuGet packages on the local file-system.
• The project must be restored using nuget restore or dotnet restore prior to scanning. After this action, you should click on the Refresh button, for the tree view to be refreshed and updated.

The CI View

The CI view of the extension allows you to view information about your builds directly from your CI system. This allows developers to keep track of the status of their code, while it is being built, tested and scanned as part of the CI pipeline, regardless of the CI provider used.

This information can be viewed inside JFrog VS Code Extension, from the JFrog Panel, after switching to CI mode.

The following details can be made available in the CI view.

• Status of the build run (passed or failed)
• Build run start time
• Git branch and latest commit message
• Link to the CI run log
• Security information about the build artifacts and dependencies

How Does It Work?

The CI information displayed in VS Code is pulled by the JFrog Extension directly from JFrog Artifactory. This information is stored in Artifactory as part of the build-info, which is published to Artifactory by the CI server.

Read more about build-info in the Build Integration documentation page. If the CI pipeline is also configured to scan the build-info by JFrog Xray, the JFrog VS Code Extension will pull the results of the scan from JFrog Xray and display them in the CI view as well.

Setting Up Your CI Pipeline

Before VS Code can display information from your CI in the CI View, your CI pipeline needs to be configured to expose this data. Read this guide which describes how to configure your CI pipeline.

Setting Up the CI View

Set your CI build name in the Build name pattern field at the Extension Settings. This is the name of the build published to Artifactory by your CI pipeline. You have the option of setting * to view all the builds published to Artifactory.

After your builds were fetched from Artifactory, press on the Builds button to choose what build to display.

Extension Settings

To open the extension settings, use the extension settings icon: Or use the following VS Code menu command:

• On Windows/Linux - File > Preferences > Settings > Extensions > JFrog
• On macOS - Code > Preferences > Settings > Extensions > JFrog

Apply Xray Policies to your Projects

You can configure the JFrog VS-Code extension to use the security policies you create in Xray. Policies enable you to create a set of rules, in which each rule defines security criteria, with a corresponding set of automatic actions according to your needs. Policies are enforced when applying them to Watches.

If you'd like to use a JFrog Project that is associated with the policy, follow these steps:

1. Create a JFrog Project, or obtain the relevant JFrog Project key.
2. Create a Policy on JFrog Xray.
3. Create a Watch on JFrog Xray and assign your Policy and Project as resources to it.
4. Configure your Project key in the Extension Settings.

If however your policies are referenced through an Xray Watch or Watches, follow these steps instead:

1. Create one or more Watches on JFrog Xray.
2. Configure your Watches in the Extension Settings.

Exclude Paths from Scan

By default, paths containing the words test, venv and node_modules are excluded from Xray scan. The exclude pattern can be configured in the Extension Settings.

Proxy Configuration

If your JFrog environment is behind an HTTP/S proxy, follow these steps to configure the proxy server:

1. Go to Preferences --> Settings --> Application --> Proxy
2. Set the proxy URL under 'Proxy'.
3. Make sure 'Proxy Support' is 'override' or 'on'.

• Alternatively, you can use the HTTP_PROXY and HTTPS_PROXY environment variables.

Proxy Authorization

If your proxy server requires credentials, follow these steps:

1. Follow 1-3 steps under Proxy configuration.

Basic authorization

1. Encode with base64: [Username]:[Password].
2. Under 'Proxy Authorization' click on 'Edit in settings.json'.
3. Add to settings.json:

• "http.proxyAuthorization": "Basic [Encoded credentials]".

Access token authorization

1. Under 'Proxy Authorization' click on 'Edit in settings.json'.
2. Add to settings.json:

• "http.proxyAuthorization": "Bearer [Access token]".

Example

• Username: foo
• Password: bar

settings.json:

{
    "http.proxyAuthorization": "Basic Zm9vOmJhcg=="
}

Troubleshooting

Change the log level to 'debug', 'info', 'warn', or 'err' in the Extension Settings.

View the extension log:

License

The extension is licensed under Apache License 2.0.

Building and Testing the Sources

Preconditions

• npm 7 and above
• JFrog CLI's jf executable - required for tests

To build the extension from sources, please follow these steps:

1. Clone the code from Github.
2. Update submodules:

git submodule init
git submodule update

3. Build and create the VS-Code extension vsix file by running the following npm command:

npm i
npm run package

After the build finishes, you'll find the vsix file in the jfrog-vscode-extension directory. The vsix file can be loaded into VS-Code

To run the tests:

npm t

Code Contributions

We welcome community contribution through pull requests.

Guidelines

• Before creating your first pull request, please join our contributors community by signing JFrog's CLA.
• If the existing tests do not already cover your changes, please add tests.
• Pull requests should be created on the dev branch.
• Please run npm run format for formatting the code before submitting the pull request.