Skip to main content

Scan for VS Code

Veracode Scan for VS Code is an extension for the VS Code IDE that integrates Static Application Security Testing (SAST), Software Composition Analysis (SCA), and Veracode Fix into your Software Development Lifecycle (SDLC).

From within your IDE, you can:

  • Run a Static Analysis of your project to detect flaws in your code and use the provided remediation guidance to resolve them.
  • Use Veracode Fix to remediate flaws by applying suggested fixes.
  • Perform SCA agent-based scans to detect vulnerabilities in open-source libraries and the risk level of third-party licenses.

Scan results are only available in the IDE. They are not available in the Veracode Platform.

Supported versions

Veracode has tested the following versions, but the integration might work with other versions.

VS Code 1.78.2 or greater

Supported languages and frameworks

Veracode has tested specific versions (if listed) of the following languages and frameworks, but the integration might work with other versions.

About application packaging

Before the extension runs a Static Analysis of your application, it uses an auto-packager to automatically package the code into a supported artifact, such as ZIP or EXE. If the packager is not able to package your application, or you prefer to create the artifact yourself, you can use the Veracode packaging guidance to package your application manually. This option does not apply to SCA scans.

By default, the extension expects the manually packaged artifact to be in $PROJECT_ROOT/.verascan. When you start the scan, the extension first looks for an artifact in the default location. To store your artifact in a different location, where the extension will look next, configure the setting veracode-scan.SAST Features.artifactGlob.

Prerequisites

Before you can install and use Veracode Scan for VS Code, you must have:

  • A supported version of VS Code and a source project of a supported language or framework. Monorepos are not supported.

  • Stored your API credentials in an API credentials file. The extension uses these credentials to authenticate with Veracode.

  • If you use a proxy to access Veracode, ensure you have configured a proxy in VS Code. You cannot configure a proxy in the Veracode extension. For more information, see the VS Code documentation.

  • To view and apply suggested fixes for flaws, you must have a Veracode Fix license and a supported code language.

  • To see the prerequisites for a scan type, select from the following:

    To run Static Analysis scans and view flaws, you must have:

    • An active Static Analysis license.
    • One of the following Veracode accounts:
      • A human user account with the Security Lead, Creator, or Submitter user role.
      • An API service account with the Upload and Scan API or Upload API - Submit Only API role.
    • To use the auto-packager, you must have one of the following package managers:
      • Java: Maven or Gradle.
      • JavaScript: NPM or Yarn.
    • Ensured your application builds successfully. If your project files change between scans, rebuild your project and ensure it builds successfully.
    • Ensured the artifact you want to scan does not exceed the total file size limit of 200 MB.
    • Enabled one-way communication on port 443.

Install the extension

Install the extension from the VS Code Marketplace the same as any other extension.

note

You can only install the extension on one machine. If you install the extension on multiple machines, the extension might fail to authenticate with Veracode.

Before you begin

Ensure you meet the prerequisites.

To complete this task:

  1. Go to the VS Code Marketplace.
  2. Search for veracode.
  3. Select Veracode Scan for VS Code.
  4. To install the extension, select Install and follow the on-screen instructions.
  5. To complete the installation, restart VS Code.
  6. In VS Code, on the Activity bar, select Veracode Scan vs-code-side-bar.png.
  7. In the SETUP view, select Install Agent to install a local agent. The extension uses this agent to upload your code to Veracode for scanning. This agent is specific to the extension and does not affect any other local Veracode agents.
  8. To apply an SCA security policy that will filter the discovered vulnerabilities, select Open policy settings. This policy does not apply to flaws.
  9. On the Settings tab, select the checkbox under Policy.
  10. From the Policy dropdown menu, select a policy to apply to your project. The menu only lists policies that contain the Findings by Severity or Vulnerability CVSS Score rule types.

To confirm your credentials are valid, by default, the extension detects your API credentials file and authenticates with Veracode. If you added the credentials file after installing the extension and the agent, select Test Authentication. If your API credentials are invalid or expired, you can generate new credentials.

Configure the extension

Configure scan settings and filter the findings that you see in the IDE.

To complete this task:

  1. To open the Settings tab, in the SCAN OVERVIEW view, select Settings vscode-settings-gear-icon.png.

  2. Configure the following options:

    • SAST Flaw.Sev Filters: to hide or show flaws in the FLAWS IN MY CODE view, add or remove the related severities.
    • SCA Features.Policy: to filter out vulnerabilities in the VULNERABILITIES IN MY LIBRARIES view, select to enable an SCA security policy that you can assign to your project. Then, from the Policy dropdown menu, select a policy. The menu only lists policies that contain the Findings by Severity or Vulnerability CVSS Score rule types. To use this option, the Unified Policy must be activated for your account. This policy does not apply to flaws.
    • SCA Features.Recursive Scan: select to run a recursive SCA scan of all folders and files in your selected project. After you select this option, you must rescan your project to update the results.
    • SCA Vulnerability.Sev Filters: to hide or show vulnerabilities in the VULNERABILITIES IN MY LIBRARIES view based on the risk level, add or remove the related severities.
    • SCA Vulnerability.Usage Filters: to filter vulnerabilities in the VULNERABILITIES IN MY LIBRARIES view based on how the project uses a vulnerable library, add or remove Direct or Transitive (indirect).
    • SAST Features.artifactGlob: provide the location of a custom artifact for a Static Analysis scan. Enter a glob pattern that defines the path and filename for your artifact. The path must be relative to your project root directory. The default location is $PROJECT_ROOT/.verascan. Ensure your artifact meets the Veracode packaging guidance. See About application packaging.

Scan your project

Scan your project to analyze the security risk of your code and all open-source libraries and licenses.

A Veracode account is limited to six scans per 60 seconds and each scan is limited to a maximum scan time of 60 minutes.

To complete this task:

  1. Open a supported project.

  2. On the Activity bar, select Veracode Scan vs-code-side-bar.png.

  3. In the SCAN OVERVIEW view, select Start Scanning. If you have already scanned this project, select Rescan vscode-sca-rescan-icon.png. If you have more than one project open, you can select the project you want to scan from the Command Palette.

    When the scan is complete, the results for the selected project appear in the following views: SCAN OVERVIEW, FLAWS IN MY CODE, VULNERABILITIES IN MY LIBRARIES, and LIBRARY LICENSES.

  4. Review the results.

Working with flaws

To review, fix, and ignore discovered flaws, use the FLAWS IN MY CODE view.

Review flaws

Review the discovered flaws in your code to learn about the flaws and their severity, and get remediation guidance.

Before you begin:

Ensure you have scanned your project.

To complete this task:

  1. On the Activity bar, select Veracode Scan vs-code-side-bar.png.

  2. In the FLAWS IN MY CODE view, you see a list of flaws. Each flaw shows the Common Weakness Enumeration (CWE) ID and name sorted by severity. The flaws with the highest severity are at the top of the list. If there are suggested fixes for a flaw, the flaw icon shows a blue dot vs-code-flaw-fix-badge.png. After you apply a suggested fix from Veracode Fix, the flaw icon changes to gray vs-code-fix-applied-icon.png.

  3. Optionally, to only show specific flaws in the list, select Filter vs-code-filter-icon.png to filter the flaws.

  4. To view a flaw within a source file, select a flaw. The source file opens in a tab and the line of code where the flaw exists is underlined red. If there are suggested fixes for the flaw, to the right of the line of code, you see Veracode fix available.

  5. To view a description of a flaw and the available remediation actions you take to fix it, in the FLAWS IN MY CODE view, select View flaw details vs-code-flaw-details-icon.png. The Flaw Details tab opens.

  6. Alternatively, to open the Flaw Details tab from a flaw in a source code file, select an underlined line of code. Then, from the Show Code Actions menu vscode-show-code-actions-icon.png, under Quick Fix, select More Information.

    The Flaw Details tab provides the CWE description for this flaw and remediation options for fixing it.

  7. To review ignored flaws, scroll down to the bottom of the view. Then, expand Ignored findings.

Filter flaws

To control which flaws are listed in the FLAWS IN MY CODE view, you can filter them.

Before you begin:

Ensure you have scanned your project.

To complete this task:

  1. In the FLAWS IN MY CODE view, select Filters vs-code-filter-icon.png.

  2. From the Filter Flaws dropdown menu, select a filter:

    • Severity: hide or show flaws based on their severity.
    • Veracode Fix: only show flaws with suggested fixes you can apply vs-code-flaw-fix-badge.png or flaws that have fixes applied vs-code-fix-applied-icon.png.
  3. To apply the filter, select OK. After you apply a filter, the filter icon shows an orange dot vs-code-filter-applied-icon.png.

Fix flaws

To fix discovered flaws, you can apply suggested fixes from Veracode Fix or follow the remediation guidance available in your IDE.

Before you begin:

  • Ensure you have scanned your project.
  • To view and apply suggested code fixes, you must have a Veracode Fix license.

To complete this task:

  1. In the FLAWS IN MY CODE view, locate a flaw you want to fix. If the flaw has suggested fixes, the severity icon shows a blue dot vs-code-flaw-fix-badge.png.

  2. Optionally, to show only flaws with suggested fixes, or flaws with fixes applied, from Veracode Fix, you can filter the flaws.

  3. To open the Flaw Details tab, point to a flaw, then select View flaw details vs-code-flaw-details-icon.png.

  4. To open the source file that contains the flaw, select the flaw. In the source file, the line of code with the flaw is underlined red.

  5. In the Flaws Details tab, select from the following tabs:

    • Veracode Fix: to apply the top suggested fix for this flaw, select Apply Fix. To apply other suggested fixes, select a fix from the Fix Option menu, then select Apply Fix. If no suggested fixes are available, this tab is empty. After you apply a suggested fix, a notification message opens with details about the applied fix and the the flaw icon in the FLAWS IN MY CODE view changes to gray vs-code-fix-applied-icon.png. If you fix a flaw manually, its flaw icon does not change to gray.
    • Remediation Guidance: view information for remediating this flaw manually. This tab also shows the data path that the scanner followed to locate the flaw, and a link to the CWE on the MITRE website.
  6. Alternatively, to open the Flaw Details tab from a flaw in the source file, locate a line of code with a flaw (underlined red) and select it. Then, from the Show Code Actions menu vscode-show-code-actions-icon.png, under Quick Fix, select either Fix this flaw or, if there are no suggested fixes, select More information.

  7. After you fix one or more flaws, rescan your project to ensure the fixed flaws no longer appear in the FLAWS IN MY CODE view. To rescan, in the SCAN OVERVIEW view, select Rescan vscode-sca-rescan-icon.png. If you are using Veracode Fix, select Rescan in the notification message that opens after you apply a fix.

Ignore flaws

To temporarily remove flaws from the scan results, you can ignore them. For example, you might want to ignore flaws that continually appear or are of low importance, such as Informational.

Before you begin:

Ensure you have scanned your project.

To complete this task:

  1. In the FLAWS IN MY CODE view, select a flaw. The source file that contains the flaw opens in a tab and the line of code where the flaw exists is underlined red.
  2. From the Show Code Actions menu vscode-show-code-actions-icon.png, under Quick Fix, locate a CWE. If the line of code contains more than one flaw, the menu lists multiple CWEs.
  3. Select the CWE, then select Ignore this finding. The flaw moves to the Ignored flaws section at the bottom of the view.
  4. To unignore a flaw, locate it in the Ignored flaws dropdown at the bottom of the FLAWS IN MY CODE view, then select Unignore flaw vscode-unignore-flaw-icon.png. The flaw moves out of the Ignored flaws dropdown and is visible in the source file.

Review vulnerabilities

To see detailed information about libraries with vulnerabilities, the vulnerability risk level, and guidance for mitigating them, review the discovered vulnerabilities for all open-source libraries in your project in the VULNERABILITIES IN MY LIBRARIES view.

If you do not have an active SCA subscription, you do not see vulnerabilities in the SCAN OVERVIEW view. The VULNERABILITIES IN MY LIBRARIES view and the LIBRARY LICENSES view are also empty.

Before you begin:

Ensure you have scanned your project.

To complete this task:

  1. On the Activity bar, select Veracode Scan vs-code-side-bar.png.

  2. In the VULNERABILITIES IN MY LIBRARIES view, you see a list of libraries sorted by risk level. The libraries with the most and highest-risk vulnerabilities are at the top of the list. The library usage appears to the right of the library.

  3. If you have enabled a security policy for your project, select Policy vscode-policy-shield-icon.png to select a different policy. If the policy is disabled, select Policy to open the policy settings.

  4. To filter the list of vulnerabilities, select Filter vs-code-filter-icon.png.

  5. Expand a library to view the detected vulnerabilities.

  6. To view information about the library, select View library details. The Library Details tab provides useful information about the library, such as the library usage, the latest version available, the known safe version, whether it has vulnerable methods, and links to more information.

  7. To view information about a vulnerability, select it. The Vulnerability Details window shows the CVSS score, the affected libraries in your project, a link for additional information in the Veracode Vulnerability Database, and the recommended fix.

  8. After you fix a vulnerability, select Rescan vscode-sca-rescan-icon.png in the SCAN OVERVIEW view to confirm that the affected library no longer has that vulnerability.

    For example, if a library in an NPM project has a vulnerability, and you update the library in the package.json file to a safe version, select Rescan to confirm that the vulnerability no longer appears in the VULNERABILITIES IN MY LIBRARIES view.

Library usage

UsageDescription
veracode-usage-direct.svg Direct dependencyThe library is a direct dependency that your project uses directly. Your project configuration file, such as package.json in an NPM project or pom.xml in a Maven project, has a reference to this library. To fix a vulnerability in a direct dependency, update the library version in the project configuration file and rebuild the project.
veracode-usage-transitive.svg Transitive dependencyThe library is a transitive dependency that your project uses indirectly through another dependency. For example, if your project configuration file has a reference to a direct library and that library has a dependency on a library not referenced in the configuration file, your project indirectly depends on that other library. If the transitive library has a vulnerability, your project is vulnerable. To fix a vulnerability in a transitive library, add a new direct reference in your project configuration file to a safe version of the library. To check if the new dependency causes any errors, such as breaking the build or showing unexpected results, rebuild and test the project.

Review open-source licenses

Review a list of all open-source licenses in your project, the libraries that use these licenses, and the license risk level. Your organization uses this information when deciding whether it might need to change a license to a safe version.

Before you begin:

Ensure you have scanned your project.

To complete this task:

  1. On the Activity bar, select Veracode Scan vs-code-side-bar.png.
  2. In the LIBRARY LICENSES view, scroll through the list of detected licenses to see the names, versions, and license risk. The licenses with the highest risk level appear at the top of the list.
  3. Expand a license to see the libraries that use it.

Clear all findings

Remove all findings from all views and the extension.

Before you begin:

Ensure you have scanned your project.

To complete this task:

note

You cannot undo this action or recover the cleared findings. To see results, rescan your project.

In the SCAN OVERVIEW view, select Clear findings vscode-clear-findings-icon.png.

Troubleshooting

To generate a log file for all scans, Veracode Fix, and the auto-packager, turn on debugging. You can use these logs to troubleshoot issues.

To turn on debugging, in the HELP & FEEDBACK view, select Debug vscode-debug-icon.png. The icon shows a red dot and the tooltip changes to Debug Enabled. The log files are stored on your local machine in .veracode/ide_agent/vscode/. The filename for each log file is the VS Code session ID at the time you started the scan. To remove these files, you must delete them manually.

note

When turned on, the debug option does not persist. You must turn it on before each scan.

To turn off debugging, select Debug to remove the red dot. The tooltip changes to Debug Disabled.

If you need additional help, contact Veracode Technical Support.