| Table of Contents |
|---|
Overview
WhiteSource Mend Advise for Visual Studio is an extension for Visual Studio that is designed to empower developers with important, valuable information on security vulnerabilities concerning open-source components employed in their development projects.
WhiteSource Mend Advise for Visual Studio does the following:
It facilitates workflows by making critical component vulnerability information available to the software developer from within the IDE, preventing the need to use a separate application for such purpose.
It offers a transparent UX for developers, by seamlessly integrating with the IDE environment. It provides a dedicated view including reported security vulnerabilities (CVEs) as well as recommendations for fixing them.
Support for Languages and Package Managers
WhiteSource Mend Advise supports C#-based projects of the following types:
SDK-style projects based on .NET Core 2.0 and above
Non-SDK-style projects based on .NET Framework 4.5.2 and above
Prerequisites
Ensure the following:
A Windows machine is being used (Linux and Mac are not supported)
A license key for WhiteSource Mend Advise for IDE, available via one of the following options:
If you do not have direct access to the WhiteSource Mend Application, obtain the license key from your WhiteSource Mend Administrator.
If you have access to the WhiteSource Mend Application, do as follows:
Go to the WhiteSource Mend Application.
Open the Profile page.
In the WhiteSource Mend Advise - IDE Integration section at the bottom, select your organization.
Copy your personal license key to be used later in Activating WhiteSource Mend Advise.
Visual Studio 2019 (any edition) is installed and you are familiar with its basic functionality
NuGet Package Manager must be installed
Supported Versions
The plugin supports Visual Studio 2019.1 and above (Enterprise, Professional, Community). The last tested version is 2022.
| Info |
|---|
Plugins for Visual Studio 2019 and Visual Studio 2022 are published to the Visual Studio Marketplace separately. |
Installing
...
Mend Advise
To install WhiteSource Mend Advise, do as follows:
Start Visual Studio.
From the menu bar, select Extensions → Manage Extensions. The Manage Extensions screen is displayed.
In the Manage Extensions screen, open the Online section from the sidebar and click Visual Studio Marketplace.
In the Search area on the right, enter whitesourceMend and press Enter.
Select the WhiteSource Mend Advise extension, and click Download.
Click Close and restart Visual Studio so that the extension can be installed.
Activating
...
Mend Advise
To activate WhiteSource Mend Advise, do as follows:
Start Visual Studio, specifying the preferred project.
From the menu bar, click Extensions → WhiteSource Mend → Activate WhiteSource Mend Advise. The Activate WhiteSource Mend Advise screen is displayed.
In Email, enter your organizational email (the email domain must be licensed to use Advise).
In License Key, enter your license key (See here for more information on how to obtain a license key).
Click Activate.
NOTE: If you check Remember license key, the activation credentials will be stored for later use. Once stored, the WhiteSource Mend Advise activation credentials will be used for all projects.
Configuring
...
Mend Advise
| Info |
|---|
Changes made to the WhiteSource Mend settings will only apply after running the next scan. |
To configure WhiteSource Mend Advise, do as follows:
From the menu bar, click Extensions → WhiteSource Mend → Options. The Options screen is displayed.
Review the options and modify if necessary. See here for a list of all options.
Click OK.
Options Table
Option | Description | Default Setting |
|---|---|---|
Automatically scan after build or rebuild action | When enabled, WhiteSource Mend will trigger a scan after a Build or Rebuild action is performed on any of your solutions/projects. | Selected (checked) |
Only show issues for direct dependencies | When enabled, WhiteSource Mend Advise will only return vulnerabilities for direct dependencies defined in your dependency file. | Unselected (not checked) |
Minimum vulnerability severity level | Alert only on detected vulnerabilities satisfying a Low/Medium/High minimum severity level.
| Low |
Include dev dependencies | Whether to alert on vulnerabilities detected in dev dependencies. | Unselected (not checked) |
Scanning for Security Vulnerabilities
To scan for security vulnerabilities, do one of the following:
Scanning a Solution
Scanning Projects
Scanning a Solution
To manually scan a solution, do any of the following:
From the menu bar, click Extensions → WhiteSource Mend → Scan Solution with WhiteSource Mend Advise
From the Solution Explorer pane, right-click the solution and from the context menu, click Scan Solution with WhiteSource Mend Advise
Scanning Projects
To manually scan one or more projects, do as follows:
Select one or multiple projects from the Solution Explorer pane.
Do one of the following options:
From the menu bar, click Extensions → WhiteSource Mend → Scan Project(s) with WhiteSource Mend Advise
From the Solution Explorer pane, right-click a project (or a selection of projects) and from the context menu, click Scan Project(s) with WhiteSource Mend Advise
Developer Focus Mode
The Developer Focus Mode allows developers to see only vulnerability alerts that are new in their feature branches compared to a predefined base branch. This promotes the security shift left approach and empowers developers to fix newly-introduced vulnerabilities immediately as part of their feature development efforts and prior to merging vulnerable code into production branches.
To enable Focus Mode, do as follows:
In the Extensions → WhiteSource Mend → Focus Mode, enable the Diff operation to be performed on a base branch checkbox.
Choose the base branch to which all other branch scans will be compared.
Make sure that your base branch is checked out, and trigger a WhiteSource Mend Advise scan either manually or by building your project.
...
| Info |
|---|
Every time the base branch configuration changes, a WhiteSource Mend Advise scan must be triggered on that branch prior to seeing new security results. |
Vulnerable Commit Alert
An alert can be enabled to notify about newly added vulnerabilities when committing the code inside the Visual Studio. This alert will appear only if the committed feature branches have new vulnerabilities compared to a preconfigured base branch.
...
Enable the Focus Mode (enable the Diff operation, choose the base branch, and trigger a WhiteSource Mend Advise scan).
Enable the Notify on new OS vulnerabilities checkbox.
...
Advanced information about the Vulnerable Commit Alert
For this feature, the Advise extension is using git hooks to block a commit when new vulnerabilities are presented in the feature branch (this is a script that will run before each commit).
The Advise extension will check if you have an active hook named pre-commit (all hooks are stored in the project directory in .git/hooks; if they have .sample extension it means that they are not used). If such a file isn't already used, Advise will update it so it can block vulnerable commits as described above.
If such a file already exists and doesn’t have a .sample extension (meaning, this script runs before each commit), Advise will not update this file or create a new one. In order for Vulnerable Commit Alert to work, you have to manually update the pre-commit file so it has the required script. For the script, please contact WhiteSource Mend Support.
Reviewing Scan Results
The WhiteSourceMend window comprises three sections:
...
A table regarding vulnerability details:
The WhiteSourceMend window expands on the vulnerability details detected by WhiteSourceMend. The window features the following columns:
Project - The scanned project where a vulnerability was found
Component - The scanned component reported to have a vulnerability
Version - The version of the scanned component reported to contain a vulnerability
Target Framework - The target .NET version of the component
Vulnerability - The identifier of the vulnerability. Clicking the identifier (link) opens the WhiteSource the Mend Vulnerability Lab providing more information.
CVSS - The security vulnerability's Common Vulnerability Scoring System (CVSS) score. If a CVSS 3 score is available, it will be displayed; otherwise, the CVSS 2 score will be displayed.
Severity - Reported severity for the vulnerability: High, Medium, Low
Dependency - Whether the vulnerable component is a Direct dependency or a Transitive dependency
Description - The description of the security vulnerability
Top Fix- The top-rated remediation advice that WhiteSource Mend recommends for each vulnerability. A condensed description of the recommended course of action is given
Additionally, you may do the following:
To sort the displayed WhiteSource Mend Advise results based on a preferred column, click the corresponding column header where possible.
...
Security vulnerability scan summary - The number of High, Medium, and Low severity vulnerabilities in the table, plus the total number of vulnerabilities
Viewing General Plugin Information
To view version information about WhiteSource about Mend Advise, do as follows:
From the menu bar, click Extensions → WhiteSource → Mend About WhiteSource Mend Advise. The About screen is displayed.
The About screen displays information about the extension version, along with links for Terms and Conditions and Privacy policy.
Upgrading
...
Mend Advise
To upgrade the WhiteSource Mend Advise extension, do as follows:
From the menu bar, select Extensions → Manage Extensions. The Manage Extensions screen is displayed.
In the Manage Extensions screen, open the Updates section from the sidebar and click Visual Studio Marketplace.
Select the WhiteSource Mend Advise extension, and click Update.
NOTE: If the WhiteSource Mend Advise extension is not displayed, a new version is not available.Click Close and restart Visual Studio so that the extension can be updated.
...
Uninstalling Mend Advise
To uninstall the extension, do as follows:
From the menu bar, select Extensions → Manage Extensions. The Manage Extensions screen is displayed.
In the Manage Extensions screen, open the Installed section from the sidebar and click Visual Studio Marketplace.
In the Search area on the right, enter whitesourceMend and press Enter.
Select the WhiteSource Mend Advise extension, and click Uninstall.
In the popup, click Yes.
Click Close and restart Visual Studio so that the extension can be uninstalled.